com.jenjinstudios.io.connection

Class ConnectionBuilder<T extends ExecutionContext>

java.lang.Object

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

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

Superclass for connection builders.

Constructor Summary

Constructors

Constructor and Description
ConnectionBuilder()

Method Summary

Modifier and Type	Method and Description
Connection<T>	build(java.io.InputStream inputStream, java.io.OutputStream outputStream) Build a Connection using the given input and output streams.
Connection<T>	build(MessageReader reader, MessageWriter writer) Build a Connection using the given MessageReader and MessageWriter.
Connection<T>	build(java.net.Socket socket) Build a Connection using the given Socket.
ConnectionBuilder<T>	withContextualTasks(java.util.function.Consumer<T>... tasks) Build a connection that includes the given contextual task to be executed synchronously with message execution.
ConnectionBuilder<T>	withErrorCallback(java.util.function.BiConsumer<Connection<T>,java.lang.Throwable> callback) Build a connection with the given error callback function.
ConnectionBuilder<T>	withExecutionContextFactory(ExecutionContextFactory<T> context) Build a connection with the given ExecutionContext.
ConnectionBuilder<T>	withMessageIOFactory(MessageIOFactory factory) Use the given MessageIOFactory to create MessageReader and MessageWriter instances from Java Input and Output streams.
ConnectionBuilder<T>	withMessageReaderFactory(MessageReaderFactory factory) Use the specified MessageReaderFactory to build a MessageReader from any InputStreams.
ConnectionBuilder<T>	withMessageWriterFactory(MessageWriterFactory factory) Use the specified MessageWriterFactory to build a MessageWriter from any OutputStreams.
ConnectionBuilder<T>	withRecurringTaskFactories(RecurringTaskFactory<T>... factories) Specify factories which generate recurring tasks.
ConnectionBuilder<T>	withRecurringTasks(RecurringTask<T>... tasks) Build a connection that include the given recurring tasks; these tasks are executed synchronously with message execution, and at regular (although undefined) intervals.
ConnectionBuilder<T>	withShutdownCallbacks(java.util.function.Consumer<Connection<T>>... callbacks) Build a connection that includes the given contextual task to be executed synchronously with message execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionBuilder

public ConnectionBuilder()

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 that will back the given Connection.

Returns:

The built Connection.

Throws:

java.io.IOException - If there is an error retrieving input and output streams from the Socket.

build

public Connection<T> build(java.io.InputStream inputStream,
                           java.io.OutputStream outputStream)

Build a Connection using the given input and output streams.

Parameters:

inputStream - The InputStream used to read messages.

outputStream - The OutputStream used to write messages.

Returns:

The built connection.

build

public Connection<T> build(MessageReader reader,
                           MessageWriter writer)

Build a Connection using the given MessageReader and MessageWriter.

Parameters:

reader - The MessageReader used to read messages.

writer - The MessageWriter used to write messages.

Returns:

The built connection.

withMessageIOFactory

public ConnectionBuilder<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.

withMessageReaderFactory

public ConnectionBuilder<T> withMessageReaderFactory(MessageReaderFactory factory)

Use the specified MessageReaderFactory to build a MessageReader from any InputStreams.

Parameters:

factory - The MessageReaderFactory.

Returns:

This SingleConnectionBuilder.

withMessageWriterFactory

public ConnectionBuilder<T> withMessageWriterFactory(MessageWriterFactory factory)

Use the specified MessageWriterFactory to build a MessageWriter from any OutputStreams.

Parameters:

factory - The MessageWriterFactory.

Returns:

This SingleConnectionBuilder.

withErrorCallback

public ConnectionBuilder<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.

withContextualTasks

public ConnectionBuilder<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 task(s) to be executed; Consumers accepting an ExecutionContext.

Returns:

This ConnectionBuilder.

withRecurringTasks

public ConnectionBuilder<T> withRecurringTasks(RecurringTask<T>... tasks)

Build a connection that include the given recurring tasks; these tasks are executed synchronously with message execution, and at regular (although undefined) intervals.

These tasks are likely to be executed very frequently (on the order of 100 times per second) so they should be kept as short as possible.

It also should be noted that there is no way to "cancel" one of these tasks.

Parameters:

tasks - The tasks to be executed repeatedly.

Returns:

This ConnectionBuilder.

withShutdownCallbacks

public ConnectionBuilder<T> withShutdownCallbacks(java.util.function.Consumer<Connection<T>>... callbacks)

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

Parameters:

callbacks - The task(s) to be executed; Consumers accepting a Connection.

Returns:

This ConnectionBuilder.

withExecutionContextFactory

public ConnectionBuilder<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

withRecurringTaskFactories

public ConnectionBuilder<T> withRecurringTaskFactories(RecurringTaskFactory<T>... factories)

Specify factories which generate recurring tasks. Useful for builders which will create multiple connections.

Parameters:

factories - The factories.

Returns:

This ConnectionBuilder.