Package dev.getelements.elements.rt

Interface AsyncConnectionGroup<ContextT,SocketT>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

JeroMQAsyncConnectionGroup

public interface AsyncConnectionGroup<ContextT,SocketT>
extends AutoCloseable

Represents a group of AsyncConnections which all are serviced by the same thread. This guarantees that each AsyncConnection may call directly into another. Closing the group will close all AsyncConnection instances contained therein. However it is not necessary to close the group explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AsyncConnectionGroup.Builder<ContextT,BuilderSocketT>

Method Summary

Modifier and Type	Method	Description
void	close()	Closes all Connection instances assocaited with this AsyncConnectionGroup.
AsyncConnection<ContextT,SocketT>	get(int index)	Gets the AsyncConnection at the provided index.
void	signal(Consumer<AsyncConnectionGroup<ContextT,SocketT>> consumer)	Similar to AsyncConnection.signal(Consumer), this executes the the supplied Consumer within the thread that is servicing all of the underlying AsyncConnection instances associated with the AsyncConnectionGroup
int	size()	Returns the number of AsyncConnection instances in this AsyncConnectionGroup.

Method Details

size

int size()

Returns the number of AsyncConnection instances in this AsyncConnectionGroup.

Returns:

the size

get

AsyncConnection<ContextT,SocketT> get(int index)

Gets the AsyncConnection at the provided index. The AsyncConnections will be returned in the order in which AsyncConnectionGroup.Builder.connection(Function, Consumer) was invoked.

Parameters:

index - the index of the AsyncConnection

Returns:

the AsyncConnection

signal

void signal(Consumer<AsyncConnectionGroup<ContextT,SocketT>> consumer)

Similar to AsyncConnection.signal(Consumer), this executes the the supplied Consumer within the thread that is servicing all of the underlying AsyncConnection instances associated with the AsyncConnectionGroup

Parameters:

consumer -

close

void close()

Closes all Connection instances assocaited with this AsyncConnectionGroup. Safe to call from any thread.

Specified by:

close in interface AutoCloseable