me.lucko.helper.messaging.conversation

Interface ConversationReplyListener<R extends ConversationMessage>

Type Parameters:

R - the reply type

public interface ConversationReplyListener<R extends ConversationMessage>

Represents an object listening for replies sent on the conversation channel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConversationReplyListener.RegistrationAction Defines the actions to take after receiving a reply in a ConversationReplyListener.

Method Summary

Modifier and Type	Method and Description
static <R extends ConversationMessage> ConversationReplyListener<R>	of(Function<? super R,ConversationReplyListener.RegistrationAction> onReply)
ConversationReplyListener.RegistrationAction	onReply(R reply) Called when a message is posted to this listener.
void	onTimeout(List<R> replies) Called when the listener times out.

Method Detail

of

static <R extends ConversationMessage> ConversationReplyListener<R> of(Function<? super R,ConversationReplyListener.RegistrationAction> onReply)

onReply

@Nonnull
ConversationReplyListener.RegistrationAction onReply(@Nonnull
                                                              R reply)

Called when a message is posted to this listener.

This method is called asynchronously.

Parameters:

reply - the reply message

Returns:

the action to take

onTimeout

void onTimeout(@Nonnull
               List<R> replies)

Called when the listener times out.

A listener times out if the "timeout wait period" passes before the listener is unregistered by other means.

"unregistered by other means" refers to the listener being stopped after a message was passed to onReply(ConversationMessage) and ConversationReplyListener.RegistrationAction.STOP_LISTENING being returned.

Parameters:

replies - the replies which have been received