Server (ETA)

All Known Implementing Classes:

JNIServer
```
public interface Server
```
The ETA Server class is used to represent a server that is listening for incoming connection requests. Any memory associated with a Server class is internally managed by the ETA Transport Package, and the application does not need to create nor destroy this type. The Server is typically used to accept or reject incoming connection attempts.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Channel`	`accept(AcceptOptions opts, Error error)` Accepts an incoming connection and returns a channel which corresponds to it. Typical use: After a server is created using the Bind call, the Accept call can be made.
`int`	`bufferUsage(Error error)` Returns the total number of used buffers for the server. Typical use: This method can be called to find out the number of used buffers for the server.
`int`	`close(Error error)` Closes a ETA Server. Typical use: When done using a Server, this call closes it.
`int`	`connectionType()` The current connection type of the server.
`int`	`info(ServerInfo info, Error error)` Gets information about the server. Typical use: If information about the `Server` is needed, such as peakBufferUsage, this method can be called to retrieve this information.
`int`	`ioctl(int code, int value, Error error)` Allows changing some I/O values programmatically for a ETA Server. Typical use: If an I/O value needs to be changed for a server, this is used.
`int`	`ioctl(int code, java.lang.Object value, Error error)` Allows changing some I/O values programmatically for a ETA Server. Typical use: If an I/O value needs to be changed for a server, this is used.
`int`	`portNumber()` Port number this server is bound to.
`java.nio.channels.SelectableChannel`	`selectableChannel()` SelectableChannel of this ETA server.
`java.nio.channels.ServerSocketChannel`	`srvrScktChannel()` Deprecated. use `selectableChannel()` instead
`int`	`state()` The state associated with this `Server`.
`java.lang.Object`	`userSpecObject()` A user specified object, possibly a closure.

- Method Detail
  - info
```
int info(ServerInfo info,
         Error error)
```
    Gets information about the server.
    Typical use:
    If information about the Server is needed, such as peakBufferUsage, this method can be called to retrieve this information.
    
    Parameters:
    
    info - ETA Server Info structure to be populated
    
    error - ETA Error, to be populated in event of an error
    
    Returns:
    
    TransportReturnCodes
    
    See Also:
    
    ServerInfo
  - ioctl
```
int ioctl(int code,
          java.lang.Object value,
          Error error)
```
    Allows changing some I/O values programmatically for a ETA Server.
    Typical use:
    If an I/O value needs to be changed for a server, this is used. Currently this only supports triggering the server peak buffer reset.
    Valid codes are:
    - IoctlCodes.SERVER_PEAK_BUF_RESET
    Parameters:
    
    code - IoctlCodes code of I/O Option to change
    
    value - Value to change Option to
    
    error - Error to be populated in event of an error
    
    Returns:
    
    TransportReturnCodes
    
    See Also:
    
    IoctlCodes
  - ioctl
```
int ioctl(int code,
          int value,
          Error error)
```
    Allows changing some I/O values programmatically for a ETA Server.
    Typical use:
    If an I/O value needs to be changed for a server, this is used. Currently this only supports changing the shared pool and receive buffer size.
    Valid codes are:
    - IoctlCodes.SERVER_NUM_POOL_BUFFERS - the return code will be the new value of sharedPoolSize or TransportReturnCodes.FAILURE. If the value is less than the number of free buffers in the shared pool (due to buffers being in use), the shared pool will be reduced by the number of free buffers.
    - IoctlCodes.SYSTEM_READ_BUFFERS - for values larger than 64K, use BindOptions.sysRecvBufSize(int) to set the receive buffer size, prior to calling Transport.bind(BindOptions, Error).
    Parameters:
    
    code - IoctlCodes code of I/O Option to change
    
    value - Value to change Option to
    
    error - Error to be populated in event of an error
    
    Returns:
    
    TransportReturnCodes or a positive number specific to the specified code.
    
    See Also:
    
    BindOptions
  - bufferUsage
```
int bufferUsage(Error error)
```
    Returns the total number of used buffers for the server.
    Typical use:
    This method can be called to find out the number of used buffers for the server. This, in combination with the bufferPoolSize used as input to the Bind call, can be used to monitor and potentially throttle buffer usage.
    
    Parameters:
    
    error - ETA Error, to be populated in event of an error
    
    Returns:
    
    If less than 0, this is a TransportReturnCodes, otherwise it is the total number of buffers in use by the server
  - close
```
int close(Error error)
```
    Closes a ETA Server.
    Typical use:
    When done using a Server, this call closes it. Active channels connected to this server will not be closed; this allows them to continue receiving data even if the server is not accepting more connections.
    
    Parameters:
    
    error - ETA Error, to be populated in event of an error
    
    Returns:
    
    TransportReturnCodes
  - accept
```
Channel accept(AcceptOptions opts,
               Error error)
```
    Accepts an incoming connection and returns a channel which corresponds to it.
    Typical use:
    After a server is created using the Bind call, the Accept call can be made. When the socketId of the server detects something to be read, this will check for incoming client connections. When a client successfully connects, a Channel is returned which corresponds to this connection. This channel can be used to read or write with the connected client. If a clients connect message is not accepted, a negative acknowledgment is sent to the client and no Channel is returned.
    
    Parameters:
    
    opts - ETA Accept Options
    
    error - ETA Error, to be populated in event of an error
    
    Returns:
    
    Accepted ETA channel or NULL
    
    See Also:
    
    AcceptOptions
  - srvrScktChannel
```
@Deprecated
java.nio.channels.ServerSocketChannel srvrScktChannel()
```
    Deprecated. use selectableChannel() instead
    
    ServerSocketChannel of this ETA server.
    
    Returns:
    
    the srvrScktChannel
  - selectableChannel
```
java.nio.channels.SelectableChannel selectableChannel()
```
    SelectableChannel of this ETA server. Use to register selector.
    
    Returns:
    
    the srvrScktChannel
  - portNumber
```
int portNumber()
```
    Port number this server is bound to.
    
    Returns:
    
    the portNumber
  - userSpecObject
```
java.lang.Object userSpecObject()
```
    A user specified object, possibly a closure. This value can be set directly or via the bind options and is not modified by the transport. This information can be useful for coupling this Server with other user created information, such as a list of associated Channel structures.
    
    Returns:
    
    the userSpecObject
  - state
```
int state()
```
    The state associated with this Server.
    
    Returns:
    
    the state
    
    See Also:
    
    ChannelState
  - connectionType
```
int connectionType()
```
    The current connection type of the server. This can be either ConnectionTypes.SOCKET or ConnectionTypes.ENCRYPTED.
    
    Returns:
    
    the server's connection type

Interface Server

Method Summary

Method Detail

info

ioctl

ioctl

bufferUsage

close

accept

srvrScktChannel

selectableChannel

portNumber

userSpecObject

state

connectionType