com.barchart.udt.net
Class NetServerSocketUDT

java.lang.Object
  java.net.ServerSocket
      com.barchart.udt.net.NetServerSocketUDT

All Implemented Interfaces:

IceCommon, IceServerSocket

Direct Known Subclasses:

NioServerSocketUDT

public class NetServerSocketUDT
extends ServerSocket
implements IceServerSocket, IceCommon

ServerSocket - like wrapper for SocketUDT

Field Summary

protected SocketUDT

socketUDT

Constructor Summary

	NetServerSocketUDT() uses TypeUDT.STREAM socket in blocking mode
protected	NetServerSocketUDT(SocketUDT socketUDT) uses provided socket keeping blocking mode

Method Summary

Socket	accept() Listens for a connection to be made to this socket and accepts it.
void	bind(SocketAddress endpoint) Binds the ServerSocket to a specific address (IP address and port number).
void	bind(SocketAddress bindpoint, int backlog) NOTE: bind() means listen() for UDT server socket
void	close() Closes this socket.
ServerSocketChannel	getChannel() Returns the unique ServerSocketChannel object associated with this socket, if any.
InetAddress	getInetAddress() Returns the local address of this server socket.
int	getLocalPort() Returns the port on which this socket is listening.
SocketAddress	getLocalSocketAddress() Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
int	getReceiveBufferSize() Gets the value of the SO_RCVBUF option for this ServerSocket, that is the proposed buffer size that will be used for Sockets accepted from this ServerSocket.
boolean	getReuseAddress() Tests if SO_REUSEADDR is enabled.
int	getSoTimeout() Retrieve setting for SO_TIMEOUT.
boolean	isBound() Returns the binding state of the ServerSocket.
boolean	isClosed() Returns the closed state of the ServerSocket.
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets performance preferences for this ServerSocket.
void	setReceiveBufferSize(int size) Sets a default proposed value for the SO_RCVBUF option for sockets accepted from this ServerSocket.
void	setReuseAddress(boolean on) Enable/disable the SO_REUSEADDR socket option.
void	setSoTimeout(int timeout) Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
SocketUDT	socketUDT() expose underlying socket

Methods inherited from class java.net.ServerSocket

implAccept, setSocketFactory, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.barchart.udt.net.IceServerSocket

toString

Field Detail

socketUDT

protected final SocketUDT socketUDT

Constructor Detail

NetServerSocketUDT

public NetServerSocketUDT()
                   throws IOException

uses TypeUDT.STREAM socket in blocking mode

Throws:

IOException

NetServerSocketUDT

protected NetServerSocketUDT(SocketUDT socketUDT)
                      throws IOException

uses provided socket keeping blocking mode

Throws:

IOException

Method Detail

accept

public Socket accept()
              throws IOException

Description copied from interface: IceServerSocket

Listens for a connection to be made to this socket and accepts it. The method blocks until a connection is made.

A new Socket s is created and, if there is a security manager, the security manager's checkAccept method is called with s.getInetAddress().getHostAddress() and s.getPort() as its arguments to ensure the operation is allowed. This could result in a SecurityException.

Specified by:

accept in interface IceServerSocket

Overrides:

accept in class ServerSocket

Returns:

the new Socket

Throws:

IOException - if an I/O error occurs when waiting for a connection.

SocketTimeoutException - if a timeout was previously set with setSoTimeout and the timeout has been reached.

See Also:

revised 1.4 spec JSR-51

bind

public void bind(SocketAddress endpoint)
          throws IOException

Description copied from interface: IceServerSocket

Binds the ServerSocket to a specific address (IP address and port number).

If the address is null, then the system will pick up an ephemeral port and a valid local address to bind the socket.

Specified by:

bind in interface IceServerSocket

Overrides:

bind in class ServerSocket

Parameters:

endpoint - The IP address & port number to bind to.

Throws:

IOException - if the bind operation fails, or if the socket is already bound.

bind

public void bind(SocketAddress bindpoint,
                 int backlog)
          throws IOException

NOTE: bind() means listen() for UDT server socket

Specified by:

bind in interface IceServerSocket

Overrides:

bind in class ServerSocket

Parameters:

bindpoint - The IP address & port number to bind to.

backlog - The listen backlog length.

Throws:

IOException - if the bind operation fails, or if the socket is already bound.

close

public void close()
           throws IOException

Description copied from interface: IceServerSocket

Closes this socket. Any thread currently blocked in IceServerSocket.accept() will throw a SocketException.

If this socket has an associated channel then the channel is closed as well.

Specified by:

close in interface IceServerSocket

Overrides:

close in class ServerSocket

Throws:

IOException - if an I/O error occurs when closing the socket. revised 1.4 spec JSR-51

getChannel

public ServerSocketChannel getChannel()

Description copied from interface: IceServerSocket

Returns the unique ServerSocketChannel object associated with this socket, if any.

A server socket will have a channel if, and only if, the channel itself was created via the ServerSocketChannel.open method.

Specified by:

getChannel in interface IceServerSocket

Overrides:

getChannel in class ServerSocket

Returns:

the server-socket channel associated with this socket, or null if this socket was not created for a channel

getInetAddress

public InetAddress getInetAddress()

Description copied from interface: IceServerSocket

Returns the local address of this server socket.

Specified by:

getInetAddress in interface IceServerSocket

Overrides:

getInetAddress in class ServerSocket

Returns:

the address to which this socket is bound, or null if the socket is unbound.

getLocalPort

public int getLocalPort()

Description copied from interface: IceServerSocket

Returns the port on which this socket is listening.

Specified by:

getLocalPort in interface IceServerSocket

Overrides:

getLocalPort in class ServerSocket

Returns:

the port number to which this socket is listening or -1 if the socket is not bound yet.

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Description copied from interface: IceServerSocket

Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.

Specified by:

getLocalSocketAddress in interface IceServerSocket

Overrides:

getLocalSocketAddress in class ServerSocket

Returns:

a SocketAddress representing the local endpoint of this socket, or null if it is not bound yet.

See Also:

IceServerSocket.getInetAddress(), IceServerSocket.getLocalPort(), IceServerSocket.bind(SocketAddress)

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Description copied from interface: IceServerSocket

Gets the value of the SO_RCVBUF option for this ServerSocket, that is the proposed buffer size that will be used for Sockets accepted from this ServerSocket.

Note, the value actually set in the accepted socket is determined by calling Socket.getReceiveBufferSize().

Specified by:

getReceiveBufferSize in interface IceServerSocket

Overrides:

getReceiveBufferSize in class ServerSocket

Returns:

the value of the SO_RCVBUF option for this Socket.

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

See Also:

IceServerSocket.setReceiveBufferSize(int)

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Description copied from interface: IceServerSocket

Tests if SO_REUSEADDR is enabled.

Specified by:

getReuseAddress in interface IceServerSocket

Overrides:

getReuseAddress in class ServerSocket

Returns:

a boolean indicating whether or not SO_REUSEADDR is enabled.

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

See Also:

IceServerSocket.setReuseAddress(boolean)

getSoTimeout

public int getSoTimeout()
                 throws IOException

Description copied from interface: IceServerSocket

Retrieve setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).

Specified by:

getSoTimeout in interface IceServerSocket

Overrides:

getSoTimeout in class ServerSocket

Returns:

the SO_TIMEOUT value

Throws:

IOException - if an I/O error occurs

See Also:

IceServerSocket.setSoTimeout(int)

isBound

public boolean isBound()

Description copied from interface: IceServerSocket

Returns the binding state of the ServerSocket.

Specified by:

isBound in interface IceServerSocket

Overrides:

isBound in class ServerSocket

Returns:

true if the ServerSocket succesfuly bound to an address

isClosed

public boolean isClosed()

Description copied from interface: IceServerSocket

Returns the closed state of the ServerSocket.

Specified by:

isClosed in interface IceServerSocket

Overrides:

isClosed in class ServerSocket

Returns:

true if the socket has been closed

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
                                      int latency,
                                      int bandwidth)

Description copied from interface: IceServerSocket

Sets performance preferences for this ServerSocket.

Sockets use the TCP/IP protocol by default. Some implementations may offer alternative protocols which have different performance characteristics than TCP/IP. This method allows the application to express its own preferences as to how these tradeoffs should be made when the implementation chooses from the available protocols.

Performance preferences are described by three integers whose values indicate the relative importance of short connection time, low latency, and high bandwidth. The absolute values of the integers are irrelevant; in order to choose a protocol the values are simply compared, with larger values indicating stronger preferences. If the application prefers short connection time over both low latency and high bandwidth, for example, then it could invoke this method with the values (1, 0, 0). If the application prefers high bandwidth above low latency, and low latency above short connection time, then it could invoke this method with the values (0, 1, 2).

Invoking this method after this socket has been bound will have no effect. This implies that in order to use this capability requires the socket to be created with the no-argument constructor.

Specified by:

setPerformancePreferences in interface IceServerSocket

Overrides:

setPerformancePreferences in class ServerSocket

Parameters:

connectionTime - An int expressing the relative importance of a short connection time

latency - An int expressing the relative importance of low latency

bandwidth - An int expressing the relative importance of high bandwidth

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Description copied from interface: IceServerSocket

Sets a default proposed value for the SO_RCVBUF option for sockets accepted from this ServerSocket. The value actually set in the accepted socket must be determined by calling Socket.getReceiveBufferSize() after the socket is returned by IceServerSocket.accept().

The value of SO_RCVBUF is used both to set the size of the internal socket receive buffer, and to set the size of the TCP receive window that is advertized to the remote peer.

It is possible to change the value subsequently, by calling Socket.setReceiveBufferSize(int). However, if the application wishes to allow a receive window larger than 64K bytes, as defined by RFC1323 then the proposed value must be set in the ServerSocket before it is bound to a local address. This implies, that the ServerSocket must be created with the no-argument constructor, then setReceiveBufferSize() must be called and lastly the ServerSocket is bound to an address by calling bind().

Failure to do this will not cause an error, and the buffer size may be set to the requested value but the TCP receive window in sockets accepted from this ServerSocket will be no larger than 64K bytes.

Specified by:

setReceiveBufferSize in interface IceServerSocket

Overrides:

setReceiveBufferSize in class ServerSocket

Parameters:

size - the size to which to set the receive buffer size. This value must be greater than 0.

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

See Also:

IceServerSocket.getReceiveBufferSize()

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Description copied from interface: IceServerSocket

Enable/disable the SO_REUSEADDR socket option.

When a TCP connection is closed the connection may remain in a timeout state for a period of time after the connection is closed (typically known as the TIME_WAIT state or 2MSL wait state). For applications using a well known socket address or port it may not be possible to bind a socket to the required SocketAddress if there is a connection in the timeout state involving the socket address or port.

Enabling SO_REUSEADDR prior to binding the socket using IceServerSocket.bind(SocketAddress) allows the socket to be bound even though a previous connection is in a timeout state.

When a ServerSocket is created the initial setting of SO_REUSEADDR is not defined. Applications can use IceServerSocket.getReuseAddress() to determine the initial setting of SO_REUSEADDR.

The behaviour when SO_REUSEADDR is enabled or disabled after a socket is bound (See IceServerSocket.isBound()) is not defined.

Specified by:

setReuseAddress in interface IceServerSocket

Overrides:

setReuseAddress in class ServerSocket

Parameters:

on - whether to enable or disable the socket option

Throws:

SocketException - if an error occurs enabling or disabling the SO_RESUEADDR socket option, or the socket is closed.

See Also:

IceServerSocket.getReuseAddress(), IceServerSocket.bind(SocketAddress), IceServerSocket.isBound(), IceServerSocket.isClosed()

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Description copied from interface: IceServerSocket

Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a call to accept() for this ServerSocket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException is raised, though the ServerSocket is still valid. The option must be enabled prior to entering the blocking operation to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout.

Specified by:

setSoTimeout in interface IceServerSocket

Overrides:

setSoTimeout in class ServerSocket

Parameters:

timeout - the specified timeout, in milliseconds

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

See Also:

IceServerSocket.getSoTimeout()

socketUDT

public SocketUDT socketUDT()

Description copied from interface: IceCommon

expose underlying socket

Specified by:

socketUDT in interface IceCommon