com.jenjinstudios.io.connection

Class MultiConnectionBuilder<T extends ExecutionContext>

java.lang.Object

com.jenjinstudios.io.connection.MultiConnectionBuilder<T>

public class MultiConnectionBuilder<T extends ExecutionContext>
extends java.lang.Object

Used to generate multiple connections from sockets.

Constructor Summary

Constructors

Constructor and Description
MultiConnectionBuilder()

Method Summary

Modifier and Type	Method and Description
Connection<T>	build(java.net.Socket socket) Build a connection using the given socket.
MultiConnectionBuilder<T>	withContextualTask(java.util.function.Consumer<T> task) Build a connection that includes the given contextual task to be executed synchronously with message execution.
MultiConnectionBuilder<T>	withContextualTasks(java.util.Collection<java.util.function.Consumer<T>> tasks) Build a connection that includes the given contextual task to be executed synchronously with message execution.
MultiConnectionBuilder<T>	withContextualTasks(java.util.function.Consumer<T>... tasks) Build a connection that includes the given contextual task to be executed synchronously with message execution.
MultiConnectionBuilder<T>	withErrorCallback(java.util.function.BiConsumer<Connection<T>,java.lang.Throwable> callback) Build a connection with the given error callback function.
MultiConnectionBuilder<T>	withExecutionContextFactory(ExecutionContextFactory<T> context) Build a connection with the given ExecutionContext.
MultiConnectionBuilder<T>	withMessageIOFactory(MessageIOFactory factory) Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.
MultiConnectionBuilder<T>	withShutdownCallback(java.util.function.Consumer<Connection<T>> callback) Build a connection that will execute the given callback on shutdown.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiConnectionBuilder

public MultiConnectionBuilder()

Method Detail

build

public Connection<T> build(java.net.Socket socket)
                    throws java.io.IOException

Build a connection using the given socket.

Parameters:

socket - The socket.

Returns:

The built connection.

Throws:

java.io.IOException - If there is an exception when building the connection.

withErrorCallback

public MultiConnectionBuilder<T> withErrorCallback(java.util.function.BiConsumer<Connection<T>,java.lang.Throwable> callback)

Build a connection with the given error callback function.

Parameters:

callback - The Consumer (accepting a Connection and Throwable) that will be invoked when an error is encountered.

Returns:

This ConnectionBuilder.

withMessageIOFactory

public MultiConnectionBuilder<T> withMessageIOFactory(MessageIOFactory factory)

Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.

Parameters:

factory - The MessageIOFactory.

Returns:

This ConnectionBuilder.

withExecutionContextFactory

public MultiConnectionBuilder<T> withExecutionContextFactory(ExecutionContextFactory<T> context)

Build a connection with the given ExecutionContext.

Parameters:

context - The context in which the Connection will execute messages.

Returns:

This ConnectionBuilder

withContextualTask

public MultiConnectionBuilder<T> withContextualTask(java.util.function.Consumer<T> task)

Build a connection that includes the given contextual task to be executed synchronously with message execution.

Parameters:

task - The task to be executed; a Consumer accepting an ExecutionContext.

Returns:

This ConnectionBuilder.

withContextualTasks

@SafeVarargs
public final MultiConnectionBuilder<T> withContextualTasks(java.util.function.Consumer<T>... tasks)

Build a connection that includes the given contextual task to be executed synchronously with message execution.

Parameters:

tasks - The tasks to be executed; Consumers accepting an ExecutionContext.

Returns:

This ConnectionBuilder.

withContextualTasks

public MultiConnectionBuilder<T> withContextualTasks(java.util.Collection<java.util.function.Consumer<T>> tasks)

Build a connection that includes the given contextual task to be executed synchronously with message execution.

Parameters:

tasks - The tasks to be executed; Consumers accepting an ExecutionContext.

Returns:

This ConnectionBuilder.

withShutdownCallback

public MultiConnectionBuilder<T> withShutdownCallback(java.util.function.Consumer<Connection<T>> callback)

Build a connection that will execute the given callback on shutdown.

Parameters:

callback - The callback to be invoked.

Returns:

This ReusableConnectionBuilder.