java.lang.Object
- net.sf.eBus.config.EConfigure.AbstractBuilder
- - net.sf.eBus.config.EConfigure.ConnectionBuilder

Enclosing class:: EConfigure

public static final class EConfigure.ConnectionBuilder
extends EConfigure.AbstractBuilder

Constructs an EConfigure.RemoteConnection instance based on the parameters set via the builder's API. The minimally allowed configuration is the connection name and address. The remaining parameters are set to the following defaults:

connection type: EConfigure.ConnectionType.TCP - plain text TCP connection.
bind port: ERemoteApp.ANY_PORT.
input buffer size: zero - use system default buffer size.
output buffer size: zero - use system default buffer size.
byte order: little-endian.
maximum message queue size: zero - unlimited queue size.
connection selector thread: AsyncChannel.defaultSelector.
reconnect flag and delay: reconnection is turned off and delay set to zero.
heartbeat millisecond delay: zero - heartbeating off.
heartbeat millisecond reply delay: zero - wait indefinitely for a reply.

Example building an `ERemoteApp`

final InetSocketAddress address = new InetSocketAddress(InetAddress.getLocalHost(), 12345);
final SSLContext secureContext = ...;
final EConfigure.ConnectionBuilder builder = EConfigure.connectionBuilder();

ERemoteApp.openConnection(builder.name("Conn0")
                                 .address(address)
                                 .bindPort(0)
                                 .connectionType(EConfigure.ConnectionType.SECURE_TCP)
                                 .sslContext(secureContext)
                                 .inputBufferSize(4_996)
                                 .outputBufferSize(8_192)
                                 .byteOrder(ByteOrder.BIG_ENDIAN)
                                 .messageQueueSize(0)
                                 .selector("connSelector")
                                 .reconnect(true)
                                 .reconnectDelay(500L)
                                 .heartbeatDelay(0L)
                                 .heartbeatReplyDelay(0L)
                                 .build());

Author:: Charles W. Rapp
See Also:: EConfigure.ServerBuilder

Field Summary
- Fields inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder
  mByteOrder, mHbDelay, mHbReplyDelay, mInputBufferSize, mMsgQueueSize, mName, mOutputBufferSize, mSSLContext

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InetSocketAddress`	`address()` Returns the configured Internet address and port.
`EConfigure.ConnectionBuilder`	`address(InetSocketAddress address)` Set the connection address.
`int`	`bindPort()` Returns the configured bind port.
`EConfigure.ConnectionBuilder`	`bindPort(int port)` Bind the connection local port to this value.
`EConfigure.RemoteConnection`	`build()` Returns the eBus connection configuration built from the previously set parameters.
`EConfigure.ConnectionBuilder`	`byteOrder(ByteOrder byteOrder)` Sets the connection byte order.
`EConfigure.ConnectionBuilder`	`connectionType(EConfigure.ConnectionType connType)` Sets the underlying channel type.
`EConfigure.ConnectionBuilder`	`heartbeatDelay(long delay)` Sets the heartbeat delay used for the connection.
`EConfigure.ConnectionBuilder`	`heartbeatReplyDelay(long delay)` Sets the heartbeat reply delay used for the connection.
`EConfigure.ConnectionBuilder`	`inputBufferSize(int size)` Sets the connection input buffer size.
`EConfigure.ConnectionBuilder`	`messageQueueSize(int size)` Sets the connection maximum queue size.
`EConfigure.ConnectionBuilder`	`name(String name)` Sets the connection name.
`EConfigure.ConnectionBuilder`	`outputBufferSize(int size)` Sets the connection output buffer size.
`boolean`	`reconnect()` Returns `true` if the connection is configured to re-establish a lost connect.
`EConfigure.ConnectionBuilder`	`reconnect(boolean flag)` Sets the reconnect flag to the given value.
`long`	`reconnectDelay()` Returns the configured millisecond reconnect delay.
`EConfigure.ConnectionBuilder`	`reconnectDelay(long time)` Sets the reconnect delay to the given value.
`String`	`selector()` Returns the configured network selector information.
`EConfigure.ConnectionBuilder`	`selector(String selector)` Sets the selector used for the connection.
`EConfigure.ConnectionBuilder`	`sslContext(SSLContext context)` Sets the SSL/TLS context used by a secure location.
`protected void`	`validate()` Validates the builder parameters.

Methods inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder
byteOrder, connectionType, heartbeatDelay, heartbeatReplyDelay, inputBufferSize, messageQueueSize, name, outputBufferSize, setByteOrder, setConnectionType, setHeartbeatDelay, setHeartbeatReplyDelay, setInputBufferSize, setMessageQueueSize, setName, setOutputBufferSize, setSSLContext, sslContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - address
```
public InetSocketAddress address()
```
    Returns the configured Internet address and port. Returns null if the address is not set.
    
    Returns:
    
    Internet address and port.
  - bindPort
```
public int bindPort()
```
    Returns the configured bind port.
    
    Returns:
    
    bind port.
  - selector
```
public String selector()
```
    Returns the configured network selector information.
    
    Returns:
    
    network selector information.
  - reconnect
```
public boolean reconnect()
```
    Returns true if the connection is configured to re-establish a lost connect.
    
    Returns:
    
    reconnection flag.
  - reconnectDelay
```
public long reconnectDelay()
```
    Returns the configured millisecond reconnect delay.
    
    Returns:
    
    millisecond reconnect delay.
  - name
```
public EConfigure.ConnectionBuilder name(String name)
```
    Sets the connection name.
    
    Parameters:
    
    name - connection name.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    NullPointerException - if name is null.
    
    IllegalArgumentException - if name is empty.
  - connectionType
```
public EConfigure.ConnectionBuilder connectionType(EConfigure.ConnectionType connType)
```
    Sets the underlying channel type.
    
    Parameters:
    
    connType - channel type.
    
    Returns:
    
    this service builder.
    
    Throws:
    
    NullPointerException - if connType is null.
  - address
```
public EConfigure.ConnectionBuilder address(InetSocketAddress address)
```
    Set the connection address.
    
    Parameters:
    
    address - connection address.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    NullPointerException - if address is null.
  - bindPort
```
public EConfigure.ConnectionBuilder bindPort(int port)
```
    Bind the connection local port to this value. If port is set to ENetConfigure.ANY_PORT, then the connection local port is set to any available value.
    
    Parameters:
    
    port - connection local bind port.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    IllegalArgumentException - if port is either < ENetConfigure.ANY_PORT or > ENetConfigure.MAX_PORT.
  - inputBufferSize
```
public EConfigure.ConnectionBuilder inputBufferSize(int size)
```
    Sets the connection input buffer size. If size is zero, then the default input buffer size is used.
    
    Parameters:
    
    size - accepted connection input buffer size.
    
    Returns:
    
    this service builder.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - outputBufferSize
```
public EConfigure.ConnectionBuilder outputBufferSize(int size)
```
    Sets the connection output buffer size. If size is zero, then the default output buffer size is used.
    
    Parameters:
    
    size - connection output buffer size.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - byteOrder
```
public EConfigure.ConnectionBuilder byteOrder(ByteOrder byteOrder)
```
    Sets the connection byte order.
    
    Parameters:
    
    byteOrder - connection serializes and de-serializes messages using this byte order.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    NullPointerException - if byteOrder is nuill.
  - messageQueueSize
```
public EConfigure.ConnectionBuilder messageQueueSize(int size)
```
    Sets the connection maximum queue size. When the message queue size reaches this maximum, the connection is automatically closed. If zero, then the message queue is allowed to grow without limit.
    
    Parameters:
    
    size - message queue maximum size.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    IllegalArgumentException - if size < zero.
  - selector
```
public EConfigure.ConnectionBuilder selector(String selector)
```
    Sets the selector used for the connection.
    
    Parameters:
    
    selector - eBus selector name.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    NullPointerException - if name is null.
    
    IllegalArgumentException - if name is an empty string or not a known selector.
  - reconnect
```
public EConfigure.ConnectionBuilder reconnect(boolean flag)
```
    Sets the reconnect flag to the given value. true means the connection will be re-established if lost; false means a lost connection is left down.
    
    Parameters:
    
    flag - establish lost connection flag.
    
    Returns:
    
    this connection builder.
    
    See Also:
    
    reconnectDelay(long)
  - reconnectDelay
```
public EConfigure.ConnectionBuilder reconnectDelay(long time)
```
    Sets the reconnect delay to the given value. This value is used on if the reconnect flag is true.
    
    Parameters:
    
    time - reconnect a lost connect after this millisecond delay.
    
    Returns:
    
    this connection builder.
    
    See Also:
    
    reconnect(boolean)
  - heartbeatDelay
```
public EConfigure.ConnectionBuilder heartbeatDelay(long delay)
```
    Sets the heartbeat delay used for the connection. If no message is received after delay milliseconds, then a heartbeat is sent. If delay is zero, then heartbeating is turned off.
    
    Parameters:
    
    delay - millisecond heartbeat rate.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    IllegalArgumentException - if delay < zero.
  - heartbeatReplyDelay
```
public EConfigure.ConnectionBuilder heartbeatReplyDelay(long delay)
```
    Sets the heartbeat reply delay used for the connection. The remote eBus application has this many milliseconds to reply to a heartbeat. If no reply is received after delay milliseconds, the connection is closed. This value is ignored if the heartbeat delay is zero (heartbeating is off).
    
    Parameters:
    
    delay - millisecond heartbeat reply delay.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    IllegalArgumentException - if delay < zero.
  - sslContext
```
public EConfigure.ConnectionBuilder sslContext(SSLContext context)
```
    Sets the SSL/TLS context used by a secure location. This should be called only if the connection type is set to EConfigure.ConnectionType.SECURE_TCP.
    
    Parameters:
    
    context - secure TCP context.
    
    Returns:
    
    this connection builder.
    
    Throws:
    
    NullPointerException - if context is null.
  - build
```
public EConfigure.RemoteConnection build()
```
    Returns the eBus connection configuration built from the previously set parameters.
    
    Returns:
    
    an eBus connection configuration.
    
    Throws:
    
    NullPointerException - if either connection name or address is not set.
    
    IllegalStateException - if reconnect flag is set to true but the reconnect delay is not set.
  - validate
```
protected void validate()
```
    Validates the builder parameters. Called for effect only.
    
    Overrides:
    
    validate in class EConfigure.AbstractBuilder
    
    Throws:
    
    NullPointerException - if a required parameter is not set.
    
    IllegalArgumentException - if a parameter is not set to a valid value with respect to another parameter.

Class EConfigure.ConnectionBuilder

Example building an ERemoteApp

Field Summary

Fields inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder

Method Summary

Methods inherited from class net.sf.eBus.config.EConfigure.AbstractBuilder

Methods inherited from class java.lang.Object

Method Detail

address

bindPort

selector

reconnect

reconnectDelay

name

connectionType

address

bindPort

inputBufferSize

outputBufferSize

byteOrder

messageQueueSize

selector

reconnect

reconnectDelay

heartbeatDelay

heartbeatReplyDelay

sslContext

build

validate

Example building an `ERemoteApp`