EConfigure.Service (eBus Configuration 5.0.0 API)

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

All Implemented Interfaces:

Comparable<EConfigure.Service>

Enclosing class:

EConfigure
```
public static final class EConfigure.Service
extends Object
implements Comparable<EConfigure.Service>
```
This immutable class stores the configuration for an eBus service. This includes:
1. Service name.
2. EConfigure.ConnectionType.
3. The TCP service port.
4. The optional address filter.
5. Each accepted socket input buffer size. Limits how many bytes are received at one time.
6. Each accepted socket output buffer size. Limits how many bytes are transmitted at one time.
7. The accepted socket input and output buffer byte ordering.
8. The accepted connection's message queue size.
9. The selector thread used by the server socket.
10. The selector thread use for accepted client sockets.
11. The accepted connection's heartbeat frequency.
12. The accepted connection's heartbeat reply time limit.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressFilter`	`addressFilter()` Returns the address filter.
`ByteOrder`	`byteOrder()` Returns the accepted connection buffer byte ordering.
`int`	`compareTo(EConfigure.Service service)` Compares this service configuration with `service` based on the service ports.
`String`	`connectionSelector()` Returns the selector information to which accepted connections are registered.
`EConfigure.ConnectionType`	`connectionType()` Returns the accepted channel type.
`boolean`	`equals(Object o)` Returns `true` if `o` is a `Service` instance with the same port and `false` otherwise.
`int`	`hashCode()` Returns the service port.
`long`	`heartbeatDelay()` Returns the heartbeat delay in milliseconds.
`long`	`heartbeatReplyDelay()` Returns the heartbeat reply delay.
`int`	`inputBufferSize()` Returns the accepted 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 accepted connection output buffer size.
`int`	`port()` Returns the service port.
`String`	`serviceSelector()` Returns the selector information to which the service socket channel is registered.
`SSLContext`	`sslContext()` Returns the SSL context used for a secure connection type.
`String`	`toString()` Returns a text representation of this eBus service.

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

- Method Detail
  - compareTo
```
public int compareTo(EConfigure.Service service)
```
    Compares this service configuration with service based on the service ports.
    
    Specified by:
    
    compareTo in interface Comparable<EConfigure.Service>
    
    Parameters:
    
    service - compare this service instance.
    
    Returns:
    
    an integer value.
  - equals
```
public boolean equals(Object o)
```
    Returns true if o is a Service instance with the same port and false otherwise.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - Test if this object is equal.
    
    Returns:
    
    true if o is a Service instance with the same port and false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the service port.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the service port.
  - toString
```
public String toString()
```
    Returns a text representation of this eBus service.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a text representation of this eBus service.
  - name
```
public String name()
```
    Returns the remote connection unique name.
    
    Returns:
    
    the remote connection unique name.
  - connectionType
```
public EConfigure.ConnectionType connectionType()
```
    Returns the accepted channel type. This is currently limited to plain text TCP and SSL/TLS secure TCP connections.
    
    Returns:
    
    connection type.
  - port
```
public int port()
```
    Returns the service port.
    
    Returns:
    
    the service port.
  - addressFilter
```
public AddressFilter addressFilter()
```
    Returns the address filter. May return nul.
    
    Returns:
    
    the address filter.
  - inputBufferSize
```
public int inputBufferSize()
```
    Returns the accepted connection input buffer size.
    
    Returns:
    
    the accepted connection input buffer size.
  - outputBufferSize
```
public int outputBufferSize()
```
    Returns the accepted connection output buffer size.
    
    Returns:
    
    the accepted connection output buffer size.
  - byteOrder
```
public ByteOrder byteOrder()
```
    Returns the accepted connection buffer byte ordering.
    
    Returns:
    
    the accepted connection 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.
  - serviceSelector
```
public String serviceSelector()
```
    Returns the selector information to which the service socket channel is registered.
    
    Returns:
    
    service socket channel selector.
  - connectionSelector
```
public String connectionSelector()
```
    Returns the selector information to which accepted connections are registered.
    
    Returns:
    
    accepted connection selector information.
  - 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.Service

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

equals

hashCode

toString

name

connectionType

port

addressFilter

inputBufferSize

outputBufferSize

byteOrder

messageQueueSize

serviceSelector

connectionSelector

heartbeatDelay

heartbeatReplyDelay

sslContext