me.lucko.helper.messaging.conversation

Interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Type Parameters:

T - the outgoing message type

R - the reply message type

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

SimpleConversationChannel

public interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>
extends Terminable

An extension of Channel providing an abstraction for two-way "conversations".

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	close() Closes this resource.
String	getName() Gets the name of the channel.
Channel<T>	getOutgoingChannel() Gets the channel for primary outgoing messages.
Channel<R>	getReplyChannel() Gets the channel replies are sent on.
ConversationChannelAgent<T,R>	newAgent() Creates a new ConversationChannelAgent for this channel.
default ConversationChannelAgent<T,R>	newAgent(ConversationChannelListener<T,R> listener) Creates a new ConversationChannelAgent for this channel, and immediately adds the given ConversationChannelListener to it.
Promise<Void>	sendMessage(T message, ConversationReplyListener<R> replyListener, long timeoutDuration, TimeUnit unit) Sends a new message to the channel.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

getName

@Nonnull
String getName()

Gets the name of the channel.

Returns:

the channel name

getOutgoingChannel

@Nonnull
Channel<T> getOutgoingChannel()

Gets the channel for primary outgoing messages.

Returns:

the outgoing channel

getReplyChannel

@Nonnull
Channel<R> getReplyChannel()

Gets the channel replies are sent on.

Returns:

the reply channel

newAgent

@Nonnull
ConversationChannelAgent<T,R> newAgent()

Creates a new ConversationChannelAgent for this channel.

Returns:

a new channel agent.

newAgent

@Nonnull
default ConversationChannelAgent<T,R> newAgent(ConversationChannelListener<T,R> listener)

Creates a new ConversationChannelAgent for this channel, and immediately adds the given ConversationChannelListener to it.

Parameters:

listener - the listener to register

Returns:

the resultant agent

sendMessage

@Nonnull
Promise<Void> sendMessage(@Nonnull
                                   T message,
                                   @Nonnull
                                   ConversationReplyListener<R> replyListener,
                                   long timeoutDuration,
                                   @Nonnull
                                   TimeUnit unit)

Sends a new message to the channel.

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

Parameters:

message - the message to dispatch

replyListener - the reply listener

timeoutDuration - the timeout duration for the reply listener

unit - the unit of timeoutDuration

Returns:

a promise which will complete when the message has sent.

close

void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable