EConfigure.RemoteConnection (eBus Configuration 5.0.0 API)

java.lang.Object
- net.sf.eBus.config.EConfigure.RemoteConnection

All Implemented Interfaces:

Comparable<EConfigure.RemoteConnection>

Enclosing class:

EConfigure
```
public static final class EConfigure.RemoteConnection
extends Object
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 frequence and heartbeat reply time limit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InetSocketAddress`	`address()` Returns the remote eBus socket address.
`int`	`bindPort()` Returns the connection bind port.
`ByteOrder`	`byteOrder()` Returns the socket buffer byte ordering.
`int`	`compareTo(EConfigure.RemoteConnection conn)` Compares `this` remote connection configuration with `conn`.
`EConfigure.ConnectionType`	`connectionType()` Returns the target channel type.
`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.
`long`	`heartbeatDelay()` Returns the heartbeat delay in milliseconds.
`long`	`heartbeatReplyDelay()` Returns the heartbeat reply delay.
`int`	`inputBufferSize()` Returns the socket 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 socket output buffer size.
`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.
`SSLContext`	`sslContext()` Returns the SSL context used for a secure connection type.
`String`	`toString()` Returns a text representation for this remote connection.

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.
  - name
```
public String name()
```
    Returns the remote connection unique name.
    
    Returns:
    
    the remote connection unique name.
  - connectionType
```
public EConfigure.ConnectionType connectionType()
```
    Returns the target channel type.
    
    Returns:
    
    channel type.
  - 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.
  - inputBufferSize
```
public int inputBufferSize()
```
    Returns the socket input buffer size.
    
    Returns:
    
    the socket input buffer size.
  - outputBufferSize
```
public int outputBufferSize()
```
    Returns the socket output buffer size.
    
    Returns:
    
    the socket output buffer size.
  - byteOrder
```
public ByteOrder byteOrder()
```
    Returns the socket buffer byte ordering.
    
    Returns:
    
    the socket buffer byte ordering.
  - messageQueueSize
```
public 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.
  - 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.
  - heartbeatDelay
```
public 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 long heartbeatReplyDelay()
```
    Returns the heartbeat reply delay. A zero value means an indefinite delay.
    
    Returns:
    
    the heartbeat reply delay.
  - sslContext
```
public 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.

Class EConfigure.RemoteConnection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

equals

hashCode

toString

name

connectionType

address

bindPort

inputBufferSize

outputBufferSize

byteOrder

messageQueueSize

selector

reconnectFlag

reconnectTime

heartbeatDelay

heartbeatReplyDelay

sslContext