me.lucko.helper.messaging

Interface Channel<T>

Type Parameters:

T - the channel message type

All Superinterfaces:

TypeAware<T>

public interface Channel<T>
extends TypeAware<T>

Represents an individual messaging channel.

Channels can be subscribed to through a ChannelAgent.

Method Summary

Modifier and Type	Method and Description
Codec<T>	getCodec() Gets the channels codec.
String	getName() Gets the name of the channel.
com.google.common.reflect.TypeToken<T>	getType() Gets the channels message type.
ChannelAgent<T>	newAgent() Creates a new ChannelAgent for this channel.
default ChannelAgent<T>	newAgent(ChannelListener<T> listener) Creates a new ChannelAgent for this channel, and immediately adds the given ChannelListener to it.
Promise<Void>	sendMessage(T message) Sends a new message to the channel.

Method Detail

getName

@Nonnull
String getName()

Gets the name of the channel.

Returns:

the channel name

getType

@Nonnull
com.google.common.reflect.TypeToken<T> getType()

Gets the channels message type.

Specified by:

getType in interface TypeAware<T>

Returns:

the channels message type.

getCodec

@Nonnull
Codec<T> getCodec()

Gets the channels codec.

Returns:

the codec

newAgent

@Nonnull
ChannelAgent<T> newAgent()

Creates a new ChannelAgent for this channel.

Returns:

a new channel agent.

newAgent

@Nonnull
default ChannelAgent<T> newAgent(ChannelListener<T> listener)

Creates a new ChannelAgent for this channel, and immediately adds the given ChannelListener to it.

Parameters:

listener - the listener to register

Returns:

the resultant agent

sendMessage

@Nonnull
Promise<Void> sendMessage(@Nonnull
                                   T message)

Sends a new message to the channel.

This method will return immediately, and the future will be completed once the message has been sent.

Parameters:

message - the message to dispatch

Returns:

a promise which will complete when the message has sent.