net.sf.eBus.config

Class EConfigure.AbstractConfig

java.lang.Object

net.sf.eBus.config.EConfigure.AbstractConfig

Direct Known Subclasses:

EConfigure.RemoteConnection, EConfigure.Service

Enclosing class:

EConfigure

public abstract static class EConfigure.AbstractConfig
extends Object

Base class for service and remote connections. Contains those data members common to both.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteOrder	mByteOrder The input and output buffer use this byte ordering.
protected boolean	mCanPause Set to true if accepted connections may be paused.
protected EConfigure.ConnectionType	mConnectionType The connections are of this type.
protected long	mHbDelay Send a heartbeat this many milliseconds after the last received input.
protected long	mHbReplyDelay Wait this many milliseconds for a heartbeat reply.
protected int	mInputBufferSize Input buffer size.
protected int	mMsgQueueSize Maximum message queue size.
protected String	mName eBus local name.
protected int	mOutputBufferSize Output buffer size.
protected EConfigure.PauseConfig	mPauseConfig If mCanPause is true, then the pause configuration is defined.
protected SSLContext	mSSLContext If mConnectionType is EConfigure.ConnectionType.SECURE_TCP, then this is the SSL context used to secure the connection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfig(EConfigure.AbstractBuilder<?> builder) Constructs the common information for service and remote connections.

Method Summary

Modifier and Type	Method and Description
ByteOrder	byteOrder() Returns connection buffer byte ordering.
boolean	canPause() Returns true if pause requests are accepted and false if not.
EConfigure.ConnectionType	connectionType() Returns the channel type.
long	heartbeatDelay() Returns the heartbeat delay in milliseconds.
long	heartbeatReplyDelay() Returns the heartbeat reply delay.
int	inputBufferSize() Returns the connection input buffer size.
int	messageQueueSize() Returns the maximum number of messages on the output queue.
String	name() Returns the remote connection unique name.
int	outputBufferSize() Returns the connection output buffer size.
EConfigure.PauseConfig	pauseConfiguration() Returns the connection pause configuration.
SSLContext	sslContext() Returns the SSL context used for a secure connection type.

Methods inherited from class java.lang.Object

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

Field Detail

mName

protected final String mName

eBus local name.

mConnectionType

protected final EConfigure.ConnectionType mConnectionType

The connections are of this type.

mInputBufferSize

protected final int mInputBufferSize

Input buffer size.

mOutputBufferSize

protected final int mOutputBufferSize

Output buffer size.

mByteOrder

protected final ByteOrder mByteOrder

The input and output buffer use this byte ordering.

mMsgQueueSize

protected final int mMsgQueueSize

Maximum message queue size.

mHbDelay

protected final long mHbDelay

Send a heartbeat this many milliseconds after the last received input. A zero value means heartbeating is not performed.

mHbReplyDelay

protected final long mHbReplyDelay

Wait this many milliseconds for a heartbeat reply. This timer is reset when a non-heartbeat reply is received. A zero value means an indefinite reply time.

mSSLContext

protected final SSLContext mSSLContext

If mConnectionType is EConfigure.ConnectionType.SECURE_TCP, then this is the SSL context used to secure the connection.

mCanPause

protected final boolean mCanPause

Set to true if accepted connections may be paused.

mPauseConfig

protected final EConfigure.PauseConfig mPauseConfig

If mCanPause is true, then the pause configuration is defined. Otherwise set to null.

Constructor Detail

AbstractConfig

protected AbstractConfig(EConfigure.AbstractBuilder<?> builder)

Constructs the common information for service and remote connections.

Parameters:

builder - connection builder.

Method Detail

name

public final String name()

Returns the remote connection unique name.

Returns:

the remote connection unique name.

connectionType

public final EConfigure.ConnectionType connectionType()

Returns the channel type. This is currently limited to plain text TCP and SSL/TLS secure TCP connections.

Returns:

connection type.

inputBufferSize

public final int inputBufferSize()

Returns the connection input buffer size.

Returns:

the connection input buffer size.

outputBufferSize

public final int outputBufferSize()

Returns the connection output buffer size.

Returns:

the connection output buffer size.

byteOrder

public final ByteOrder byteOrder()

Returns connection buffer byte ordering.

Returns:

the connection buffer byte ordering.

messageQueueSize

public final int messageQueueSize()

Returns the maximum number of messages on the output queue. Returns zero if there is no limit.

Returns:

the message queue maximum size.

heartbeatDelay

public final long heartbeatDelay()

Returns the heartbeat delay in milliseconds. A zero value means that heartbeating is not performed.

Returns:

the heartbeat delay in milliseconds.

heartbeatReplyDelay

public final long heartbeatReplyDelay()

Returns the heartbeat reply delay. A zero value means an indefinite delay.

Returns:

the heartbeat reply delay.

sslContext

public final SSLContext sslContext()

Returns the SSL context used for a secure connection type. Returns null if connection type is not EConfigure.ConnectionType.SECURE_TCP.

Returns:

SSL context. May return null.

canPause

public final boolean canPause()

Returns true if pause requests are accepted and false if not.

Returns:

true if accepted connections may be paused.

pauseConfiguration

public final EConfigure.PauseConfig pauseConfiguration()

Returns the connection pause configuration. If canPause() returns false, then returns null.

Returns:

connection pause configuration.