Package dev.getelements.elements.rt

Interface AsyncConnection<ContextT,SocketT>

All Superinterfaces:

AutoCloseable, Connection<ContextT,SocketT>

public interface AsyncConnection<ContextT,SocketT>
extends Connection<ContextT,SocketT>

Represents an asynchornous type of Connection. Unless otherwise indicated, instances of AsyncConnection aren't thread-safe. Therefore you must ensure that all manipulation of the AsyncConnection instance is performed within a callback from the subscribed events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AsyncConnection.Event	Enumeration of events for which to listen.

Method Summary

Modifier and Type	Method	Description
default void	clearEvents()	Clears all events until a subsequent call to setEvents(Event...) is made.
Subscription	onClose(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Registers a Subscription for when the underlying connection was closed.
Subscription	onError(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Registers a Subscription for when a socket has encountered an error.
Subscription	onRead(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Registers a Subscription for when a socket has read data.
Subscription	onRecycle(Consumer<AsyncConnection<ContextT,SocketT>> pooledAsyncConnectionConsumer)	Subscribes to an event indicating that the connection was recycled.
Subscription	onWrite(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Registers a Subscription for when a socket is ready to write data.
void	recycle()	Returns this AsyncConnection.
void	setEvents(AsyncConnection.Event... events)	Ensures that the AsyncConnection is registered for the supplied events.
void	signal(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Sends a signal to this AsyncConnection.
default <T> CompletionStage<T>	signalAndComputeCompletion(Function<AsyncConnection<ContextT,SocketT>,T> asyncConnectionConsumer)	Computes a value on the connection's IO Thread.
default CompletionStage<Void>	signalAndComputeCompletionV(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)	Computes a value on the connection's IO Thread.

Methods inherited from interface dev.getelements.elements.rt.Connection

close, context, socket

Method Details

signal

void signal(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Sends a signal to this AsyncConnection. The signal will run on the AsyncConnection's thread and can be used to safely manipulate the AsyncConnection from an outside thread. This method, and other "signal" methods, may be invoked from any thread.

Parameters:

asyncConnectionConsumer - the Consumer<AsyncConnection> to receive the event

signalAndComputeCompletion

default <T> CompletionStage<T> signalAndComputeCompletion(Function<AsyncConnection<ContextT,SocketT>,T> asyncConnectionConsumer)

Computes a value on the connection's IO Thread. This will return a CompletionStage<T> which may be used to retrieve the value.

Type Parameters:

T - the type to compute

Parameters:

asyncConnectionConsumer - the consumer.

Returns:

the CompletionStage<T>

signalAndComputeCompletionV

default CompletionStage<Void> signalAndComputeCompletionV(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Computes a value on the connection's IO Thread. This will return a CompletionStage<Void> which may be used to block until the IO thread completes the supplied task.

Parameters:

asyncConnectionConsumer - the consumer to execute the task

Returns:

the CompletionStage<Void>

recycle

void recycle()

Returns this AsyncConnection. This hints to the underlying AsyncConnectionService that the client code is done using the connection. Depending on circumstances, this may simply close the connection.

clearEvents

default void clearEvents()

Clears all events until a subsequent call to setEvents(Event...) is made. This may be a shortcut for simply passing no arguments to setEvents(Event...).

setEvents

void setEvents(AsyncConnection.Event... events)

Ensures that the AsyncConnection is registered for the supplied events.

Parameters:

events - one of many AsyncConnection.Events

onRead

Subscription onRead(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Registers a Subscription for when a socket has read data.

Parameters:

asyncConnectionConsumer - the Consumer<AsyncConnection<ContextT,SocketT>> to receive the event

Returns:

Subscription

onWrite

Subscription onWrite(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Registers a Subscription for when a socket is ready to write data.

Parameters:

asyncConnectionConsumer - the Consumer<AsyncConnection<ContextT,SocketT>> to receive the event

Returns:

Subscription

onError

Subscription onError(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Registers a Subscription for when a socket has encountered an error.

Parameters:

asyncConnectionConsumer - the Consumer<AsyncConnection<ContextT,SocketT>> to receive the event

Returns:

Subscription

onClose

Subscription onClose(Consumer<AsyncConnection<ContextT,SocketT>> asyncConnectionConsumer)

Registers a Subscription for when the underlying connection was closed.

Parameters:

asyncConnectionConsumer - the Consumer to receive the event

Returns:

Subscription

onRecycle

Subscription onRecycle(Consumer<AsyncConnection<ContextT,SocketT>> pooledAsyncConnectionConsumer)

Subscribes to an event indicating that the connection was recycled.

Parameters:

pooledAsyncConnectionConsumer - the Consumer to receive the event.

Returns:

a Subscription to the event