me.lucko.helper.messaging

Interface ChannelAgent<T>

Type Parameters:

T - the channel message type

All Superinterfaces:

AutoCloseable, Terminable

public interface ChannelAgent<T>
extends Terminable

Represents an agent for interacting with a Channels message streams.

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
boolean	addListener(ChannelListener<T> listener) Adds a new listener to the channel;
void	close() Closes this resource.
Channel<T>	getChannel() Gets the channel this agent is acting for.
Set<ChannelListener<T>>	getListeners() Gets an immutable copy of the listeners currently held by this agent.
boolean	hasListeners() Gets if this agent has any active listeners.
boolean	removeListener(ChannelListener<T> listener) Removes a listener from the channel.

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

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

getChannel

@Nonnull
Channel<T> getChannel()

Gets the channel this agent is acting for.

Returns:

the parent channel

getListeners

@Nonnull
Set<ChannelListener<T>> getListeners()

Gets an immutable copy of the listeners currently held by this agent.

Returns:

the active listeners

hasListeners

boolean hasListeners()

Gets if this agent has any active listeners.

Returns:

true if this agent has listeners

addListener

boolean addListener(@Nonnull
                    ChannelListener<T> listener)

Adds a new listener to the channel;

Parameters:

listener - the listener to add

Returns:

true if successful

removeListener

boolean removeListener(@Nonnull
                       ChannelListener<T> listener)

Removes a listener from the channel.

Parameters:

listener - the listener to remove

Returns:

true if successful

close

void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable