net.sf.eBus.config

Class EConfigure.RemoteConnection

java.lang.Object

net.sf.eBus.config.EConfigure.AbstractConfig

net.sf.eBus.config.EConfigure.RemoteConnection

All Implemented Interfaces:

Comparable<EConfigure.RemoteConnection>

Enclosing class:

EConfigure

public static final class EConfigure.RemoteConnection
extends EConfigure.AbstractConfig
implements Comparable<EConfigure.RemoteConnection>

This immutable class stores the information pertaining to a remote eBus connection. This includes:

1. Service name.
2. EConfigure.ConnectionType.
3. The TCP/IP address and port.
4. The TCP/IP bind port. This is is the TCP port to which the connection's local end is bound. If the bind port is zero, then the local end is bound to any available TCP port.
5. The socket input buffer size. Limits how many bytes are received at one time.
6. The socket output buffer size. Limits how many bytes are transmitted at one time.
7. The socket input and output buffer byte ordering.
8. The connection maximum message queue size . If the message queue exceeds this size, then the socket is disconnected.
9. The selector thread used to monitor the socket.
10. A reconnect flag which, if true, means that the connection is re-established if lost.
11. When reconnecting wait this many milliseconds before attempting to re-establish the connection.
12. The heartbeat frequency and heartbeat reply time limit.

Field Summary

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

mByteOrder, mCanPause, mConnectionType, mHbDelay, mHbReplyDelay, mInputBufferSize, mMsgQueueSize, mName, mOutputBufferSize, mPauseConfig, mSSLContext

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	address() Returns the remote eBus socket address.
int	bindPort() Returns the connection bind port.
int	compareTo(EConfigure.RemoteConnection conn) Compares this remote connection configuration with conn.
boolean	equals(Object o) Returns true if o is a non-null RemoteConnection instance with the same name; false otherwise.
int	hashCode() Returns the remote connection address hash code.
ProtocolFamily	protocol()
boolean	reconnectFlag() Returns true if connection is to be re-established when lost.
long	reconnectTime() Returns the reconnect delay.
String	selector() Returns the selector information to which this connection is registered.
String	toString() Returns a text representation for this remote connection.

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

byteOrder, canPause, connectionType, heartbeatDelay, heartbeatReplyDelay, inputBufferSize, messageQueueSize, name, outputBufferSize, pauseConfiguration, sslContext

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public int compareTo(EConfigure.RemoteConnection conn)

Compares this remote connection configuration with conn.

Specified by:

compareTo in interface Comparable<EConfigure.RemoteConnection>

Parameters:

conn - compare with this object.

Returns:

< zero if this instance is less than conn; zero if this instance is equal to conn; > zero if this is greater than conn.

equals

public boolean equals(Object o)

Returns true if o is a non-null RemoteConnection instance with the same name; false otherwise.

Overrides:

equals in class Object

Parameters:

o - Test equality with this object.

Returns:

true if o is a non-null RemoteConnection instance with the same address and connection type; false otherwise.

hashCode

public int hashCode()

Returns the remote connection address hash code.

Overrides:

hashCode in class Object

Returns:

the remote connection address hash code.

toString

public String toString()

Returns a text representation for this remote connection.

Overrides:

toString in class Object

Returns:

a text representation for this remote connection.

address

public InetSocketAddress address()

Returns the remote eBus socket address.

Returns:

the remote eBus socket address.

bindPort

public int bindPort()

Returns the connection bind port. This is the TCP port to which the local end is bound.

Returns:

the connection bind port.

selector

public String selector()

Returns the selector information to which this connection is registered.

Returns:

selector information.

reconnectFlag

public boolean reconnectFlag()

Returns true if connection is to be re-established when lost.

Returns:

true if connection is to be re-established when lost.

reconnectTime

public long reconnectTime()

Returns the reconnect delay.

Returns:

the reconnect delay.

protocol

public ProtocolFamily protocol()