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
String	getName() Gets the name of the channel.
TypeToken<T>	getType() Gets the channels message type.
ChannelAgent<T>	newAgent() Creates a new ChannelAgent for this channel.
CompletableFuture<Boolean>	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
TypeToken<T> getType()

Gets the channels message type.

Specified by:

getType in interface TypeAware<T>

Returns:

the channels message type.

newAgent

@Nonnull
ChannelAgent<T> newAgent()

Creates a new ChannelAgent for this channel.

Returns:

a new channel agent.

sendMessage

@Nonnull
CompletableFuture<Boolean> 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.

The future will return true if the message was sent successfully.

Parameters:

message - the message to dispatch

Returns:

a future which will complete when the message has sent.