me.lucko.helper.messaging.conversation

Class SimpleConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

java.lang.Object

me.lucko.helper.messaging.conversation.SimpleConversationChannel<T,R>

Type Parameters:

T - the outgoing message type

R - the reply message type

All Implemented Interfaces:

AutoCloseable, ConversationChannel<T,R>, Terminable

public class SimpleConversationChannel<T extends ConversationMessage,R extends ConversationMessage>
extends Object
implements ConversationChannel<T,R>

Simple implementation of ConversationChannel.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SimpleConversationChannel(Messenger messenger, String name, com.google.common.reflect.TypeToken<T> outgoingType, com.google.common.reflect.TypeToken<R> replyType)

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.
Promise<Void>	sendMessage(T message, ConversationReplyListener<R> replyListener, long timeoutDuration, TimeUnit unit) Sends a new message to the channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.lucko.helper.messaging.conversation.ConversationChannel

newAgent

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

bindWith, closeAndReportException, closeSilently, isClosed

Constructor Detail

SimpleConversationChannel

public SimpleConversationChannel(Messenger messenger,
                                 String name,
                                 com.google.common.reflect.TypeToken<T> outgoingType,
                                 com.google.common.reflect.TypeToken<R> replyType)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: ConversationChannel

Gets the name of the channel.

Specified by:

getName in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Returns:

the channel name

getOutgoingChannel

@Nonnull
public Channel<T> getOutgoingChannel()

Description copied from interface: ConversationChannel

Gets the channel for primary outgoing messages.

Specified by:

getOutgoingChannel in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Returns:

the outgoing channel

getReplyChannel

@Nonnull
public Channel<R> getReplyChannel()

Description copied from interface: ConversationChannel

Gets the channel replies are sent on.

Specified by:

getReplyChannel in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Returns:

the reply channel

newAgent

@Nonnull
public ConversationChannelAgent<T,R> newAgent()

Description copied from interface: ConversationChannel

Creates a new ConversationChannelAgent for this channel.

Specified by:

newAgent in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Returns:

a new channel agent.

sendMessage

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

Description copied from interface: ConversationChannel

Sends a new message to the channel.

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

Specified by:

sendMessage in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

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

public void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ConversationChannel<T extends ConversationMessage,R extends ConversationMessage>

Specified by:

close in interface Terminable