com.barchart.udt.net
Class NetSocketUDT

java.lang.Object
  java.net.Socket
      com.barchart.udt.net.NetSocketUDT

All Implemented Interfaces:

IceCommon, IceSocket

Direct Known Subclasses:

NioSocketUDT

public class NetSocketUDT
extends Socket
implements IceSocket, IceCommon

Socket - like wrapper for SocketUDT

Field Summary

protected InputStream	inputStream
protected OutputStream	outputStream
protected SocketUDT	socketUDT

Constructor Summary

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

Method Summary

void	bind(SocketAddress bindpoint) Binds the socket to a local address.
void	close() Closes this socket.
void	connect(SocketAddress endpoint) Connects this socket to the server.
void	connect(SocketAddress endpoint, int timeout) Connects this socket to the server with a specified timeout value.
SocketChannel	getChannel() Returns the unique SocketChannel object associated with this socket, if any.
InetAddress	getInetAddress() Returns the address to which the socket is connected.
InputStream	getInputStream() Returns an input stream for this socket.
boolean	getKeepAlive() Tests if SO_KEEPALIVE is enabled.
InetAddress	getLocalAddress() Gets the local address to which the socket is bound.
int	getLocalPort() Returns the local port to which this socket is bound.
SocketAddress	getLocalSocketAddress() Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
boolean	getOOBInline() Tests if OOBINLINE is enabled.
OutputStream	getOutputStream() Returns an output stream for this socket.
int	getPort() Returns the remote port to which this socket is connected.
int	getReceiveBufferSize() Gets the value of the SO_RCVBUF option for this Socket, that is the buffer size used by the platform for input on this Socket.
SocketAddress	getRemoteSocketAddress() Returns the address of the endpoint this socket is connected to, or null if it is unconnected.
boolean	getReuseAddress() Tests if SO_REUSEADDR is enabled.
int	getSendBufferSize() Get value of the SO_SNDBUF option for this Socket, that is the buffer size used by the platform for output on this Socket.
int	getSoLinger() Returns setting for SO_LINGER.
int	getSoTimeout() Returns setting for SO_TIMEOUT.
boolean	getTcpNoDelay() Tests if TCP_NODELAY is enabled.
int	getTrafficClass() Gets traffic class or type-of-service in the IP header for packets sent from this Socket
boolean	isBound() Returns the binding state of the socket.
boolean	isClosed() Returns the closed state of the socket.
boolean	isConnected() Returns the connection state of the socket.
boolean	isInputShutdown() Returns whether the read-half of the socket connection is closed.
boolean	isOutputShutdown() Returns whether the write-half of the socket connection is closed.
void	sendUrgentData(int data) Send one byte of urgent data on the socket.
void	setKeepAlive(boolean on) Enable/disable SO_KEEPALIVE.
void	setOOBInline(boolean on) Enable/disable OOBINLINE (receipt of TCP urgent data) By default, this option is disabled and TCP urgent data received on a socket is silently discarded.
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets performance preferences for this socket.
void	setReceiveBufferSize(int size) Sets the SO_RCVBUF option to the specified value for this Socket .
void	setReuseAddress(boolean on) Enable/disable the SO_REUSEADDR socket option.
void	setSendBufferSize(int size) Sets the SO_SNDBUF option to the specified value for this Socket .
void	setSoLinger(boolean on, int linger) Enable/disable SO_LINGER with the specified linger time in seconds.
void	setSoTimeout(int timeout) Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
void	setTcpNoDelay(boolean on) Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
void	setTrafficClass(int tc) Sets traffic class or type-of-service octet in the IP header for packets sent from this Socket.
void	shutdownInput() Places the input stream for this socket at "end of stream".
void	shutdownOutput() Disables the output stream for this socket.
SocketUDT	socketUDT() expose underlying socket

Methods inherited from class java.net.Socket

setSocketImplFactory, toString

Methods inherited from class java.lang.Object

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

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

toString

Field Detail

inputStream

@ThreadSafe(value="this")
protected InputStream inputStream

outputStream

@ThreadSafe(value="this")
protected OutputStream outputStream

socketUDT

protected final SocketUDT socketUDT

Constructor Detail

NetSocketUDT

public NetSocketUDT()
             throws ExceptionUDT

uses TypeUDT.STREAM socket in blocking mode

Throws:

ExceptionUDT

NetSocketUDT

protected NetSocketUDT(SocketUDT socketUDT)

uses provided socket keeping blocking mode

Method Detail

bind

public void bind(SocketAddress bindpoint)
          throws IOException

Description copied from interface: IceSocket

Binds the socket to a local address.

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 IceSocket

Overrides:

bind in class Socket

Parameters:

bindpoint - the SocketAddress to bind to

Throws:

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

See Also:

IceSocket.isBound()

close

public void close()
           throws IOException

Description copied from interface: IceSocket

Closes this socket.

Any thread currently blocked in an I/O operation upon this socket will throw a SocketException.

Once a socket has been closed, it is not available for further networking use (i.e. can't be reconnected or rebound). A new socket needs to be created.

Closing this socket will also close the socket's InputStream and OutputStream.

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

Specified by:

close in interface IceSocket

Overrides:

close in class Socket

Throws:

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

See Also:

IceSocket.isClosed()

connect

public void connect(SocketAddress endpoint)
             throws IOException

Description copied from interface: IceSocket

Connects this socket to the server.

Specified by:

connect in interface IceSocket

Overrides:

connect in class Socket

Parameters:

endpoint - the SocketAddress

Throws:

IOException - if an error occurs during the connection

connect

public void connect(SocketAddress endpoint,
                    int timeout)
             throws IOException

Description copied from interface: IceSocket

Connects this socket to the server with a specified timeout value. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs.

Specified by:

connect in interface IceSocket

Overrides:

connect in class Socket

Parameters:

endpoint - the SocketAddress

timeout - the timeout value to be used in milliseconds.

Throws:

IOException - if an error occurs during the connection

SocketTimeoutException - if timeout expires before connecting

getChannel

public SocketChannel getChannel()

Description copied from interface: IceSocket

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

A socket will have a channel if, and only if, the channel itself was created via the SocketChannel.open or ServerSocketChannel.accept methods.

Specified by:

getChannel in interface IceSocket

Overrides:

getChannel in class Socket

Returns:

the 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: IceSocket

Returns the address to which the socket is connected.

Specified by:

getInetAddress in interface IceSocket

Overrides:

getInetAddress in class Socket

Returns:

the remote IP address to which this socket is connected, or null if the socket is not connected.

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: IceSocket

Returns an input stream for this socket.

If this socket has an associated channel then the resulting input stream delegates all of its operations to the channel. If the channel is in non-blocking mode then the input stream's read operations will throw an IllegalBlockingModeException.

Under abnormal conditions the underlying connection may be broken by the remote host or the network software (for example a connection reset in the case of TCP connections). When a broken connection is detected by the network software the following applies to the returned input stream :-

• The network software may discard bytes that are buffered by the socket. Bytes that aren't discarded by the network software can be read using read.

• If there are no bytes buffered on the socket, or all buffered bytes have been consumed by read, then all subsequent calls to read will throw an IOException.

• If there are no bytes buffered on the socket, and the socket has not been closed using close, then available will return 0.

Closing the returned InputStream will close the associated socket.

Specified by:

getInputStream in interface IceSocket

Overrides:

getInputStream in class Socket

Returns:

an input stream for reading bytes from this socket.

Throws:

IOException - if an I/O error occurs when creating the input stream, the socket is closed, the socket is not connected, or the socket input has been shutdown using IceSocket.shutdownInput() revised 1.4 spec JSR-51

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException

Description copied from interface: IceSocket

Tests if SO_KEEPALIVE is enabled.

Specified by:

getKeepAlive in interface IceSocket

Overrides:

getKeepAlive in class Socket

Returns:

a boolean indicating whether or not SO_KEEPALIVE is enabled.

Throws:

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

See Also:

IceSocket.setKeepAlive(boolean)

getLocalAddress

public InetAddress getLocalAddress()

Description copied from interface: IceSocket

Gets the local address to which the socket is bound.

Specified by:

getLocalAddress in interface IceSocket

Overrides:

getLocalAddress in class Socket

Returns:

the local address to which the socket is bound or InetAddress.anyLocalAddress() if the socket is not bound yet.

getLocalPort

public int getLocalPort()

Description copied from interface: IceSocket

Returns the local port to which this socket is bound.

Specified by:

getLocalPort in interface IceSocket

Overrides:

getLocalPort in class Socket

Returns:

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

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Description copied from interface: IceSocket

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

Specified by:

getLocalSocketAddress in interface IceSocket

Overrides:

getLocalSocketAddress in class Socket

Returns:

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

See Also:

IceSocket.getLocalAddress(), IceSocket.getLocalPort(), IceSocket.bind(SocketAddress)

getOOBInline

public boolean getOOBInline()
                     throws SocketException

Description copied from interface: IceSocket

Tests if OOBINLINE is enabled.

Specified by:

getOOBInline in interface IceSocket

Overrides:

getOOBInline in class Socket

Returns:

a boolean indicating whether or not OOBINLINE is enabled.

Throws:

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

See Also:

IceSocket.setOOBInline(boolean)

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: IceSocket

Returns an output stream for this socket.

If this socket has an associated channel then the resulting output stream delegates all of its operations to the channel. If the channel is in non-blocking mode then the output stream's write operations will throw an IllegalBlockingModeException.

Closing the returned OutputStream will close the associated socket.

Specified by:

getOutputStream in interface IceSocket

Overrides:

getOutputStream in class Socket

Returns:

an output stream for writing bytes to this socket.

Throws:

IOException - if an I/O error occurs when creating the output stream or if the socket is not connected. revised 1.4 spec JSR-51

getPort

public int getPort()

Description copied from interface: IceSocket

Returns the remote port to which this socket is connected.

Specified by:

getPort in interface IceSocket

Overrides:

getPort in class Socket

Returns:

the remote port number to which this socket is connected, or 0 if the socket is not connected yet.

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Description copied from interface: IceSocket

Gets the value of the SO_RCVBUF option for this Socket, that is the buffer size used by the platform for input on this Socket.

Specified by:

getReceiveBufferSize in interface IceSocket

Overrides:

getReceiveBufferSize in class Socket

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:

IceSocket.setReceiveBufferSize(int)

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Description copied from interface: IceSocket

Returns the address of the endpoint this socket is connected to, or null if it is unconnected.

Specified by:

getRemoteSocketAddress in interface IceSocket

Overrides:

getRemoteSocketAddress in class Socket

Returns:

a SocketAddress reprensenting the remote endpoint of this socket, or null if it is not connected yet.

See Also:

IceSocket.getInetAddress(), IceSocket.getPort(), IceSocket.connect(SocketAddress, int), IceSocket.connect(SocketAddress)

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Description copied from interface: IceSocket

Tests if SO_REUSEADDR is enabled.

Specified by:

getReuseAddress in interface IceSocket

Overrides:

getReuseAddress in class Socket

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:

IceSocket.setReuseAddress(boolean)

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Description copied from interface: IceSocket

Get value of the SO_SNDBUF option for this Socket, that is the buffer size used by the platform for output on this Socket.

Specified by:

getSendBufferSize in interface IceSocket

Overrides:

getSendBufferSize in class Socket

Returns:

the value of the SO_SNDBUF option for this Socket.

Throws:

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

See Also:

IceSocket.setSendBufferSize(int)

getSoLinger

public int getSoLinger()
                throws SocketException

Description copied from interface: IceSocket

Returns setting for SO_LINGER. -1 returns implies that the option is disabled. The setting only affects socket close.

Specified by:

getSoLinger in interface IceSocket

Overrides:

getSoLinger in class Socket

Returns:

the setting for SO_LINGER.

Throws:

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

See Also:

IceSocket.setSoLinger(boolean, int)

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Description copied from interface: IceSocket

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

Specified by:

getSoTimeout in interface IceSocket

Overrides:

getSoTimeout in class Socket

Returns:

the setting for SO_TIMEOUT

Throws:

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

See Also:

IceSocket.setSoTimeout(int)

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException

Description copied from interface: IceSocket

Tests if TCP_NODELAY is enabled.

Specified by:

getTcpNoDelay in interface IceSocket

Overrides:

getTcpNoDelay in class Socket

Returns:

a boolean indicating whether or not TCP_NODELAY is enabled.

Throws:

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

See Also:

IceSocket.setTcpNoDelay(boolean)

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Description copied from interface: IceSocket

Gets traffic class or type-of-service in the IP header for packets sent from this Socket

As the underlying network implementation may ignore the traffic class or type-of-service set using IceSocket.setTrafficClass(int) this method may return a different value than was previously set using the IceSocket.setTrafficClass(int) method on this Socket.

Specified by:

getTrafficClass in interface IceSocket

Overrides:

getTrafficClass in class Socket

Returns:

the traffic class or type-of-service already set

Throws:

SocketException - if there is an error obtaining the traffic class or type-of-service value.

See Also:

IceSocket.setTrafficClass(int)

isBound

public boolean isBound()

Description copied from interface: IceSocket

Returns the binding state of the socket.

Specified by:

isBound in interface IceSocket

Overrides:

isBound in class Socket

Returns:

true if the socket successfuly bound to an address

See Also:

IceSocket.bind(java.net.SocketAddress)

isClosed

public boolean isClosed()

Description copied from interface: IceSocket

Returns the closed state of the socket.

Specified by:

isClosed in interface IceSocket

Overrides:

isClosed in class Socket

Returns:

true if the socket has been closed

See Also:

IceSocket.close()

isConnected

public boolean isConnected()

Description copied from interface: IceSocket

Returns the connection state of the socket.

Specified by:

isConnected in interface IceSocket

Overrides:

isConnected in class Socket

Returns:

true if the socket successfuly connected to a server

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: IceSocket

Returns whether the read-half of the socket connection is closed.

Specified by:

isInputShutdown in interface IceSocket

Overrides:

isInputShutdown in class Socket

Returns:

true if the input of the socket has been shutdown

See Also:

IceSocket.shutdownInput()

isOutputShutdown

public boolean isOutputShutdown()

Description copied from interface: IceSocket

Returns whether the write-half of the socket connection is closed.

Specified by:

isOutputShutdown in interface IceSocket

Overrides:

isOutputShutdown in class Socket

Returns:

true if the output of the socket has been shutdown

See Also:

IceSocket.shutdownOutput()

sendUrgentData

public void sendUrgentData(int data)
                    throws IOException

Description copied from interface: IceSocket

Send one byte of urgent data on the socket. The byte to be sent is the lowest eight bits of the data parameter. The urgent byte is sent after any preceding writes to the socket OutputStream and before any future writes to the OutputStream.

Specified by:

sendUrgentData in interface IceSocket

Overrides:

sendUrgentData in class Socket

Parameters:

data - The byte of data to send

Throws:

IOException - if there is an error sending the data.

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException

Description copied from interface: IceSocket

Enable/disable SO_KEEPALIVE.

Specified by:

setKeepAlive in interface IceSocket

Overrides:

setKeepAlive in class Socket

Parameters:

on - whether or not to have socket keep alive turned on.

Throws:

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

See Also:

IceSocket.getKeepAlive()

setOOBInline

public void setOOBInline(boolean on)
                  throws SocketException

Description copied from interface: IceSocket

Enable/disable OOBINLINE (receipt of TCP urgent data) By default, this option is disabled and TCP urgent data received on a socket is silently discarded. If the user wishes to receive urgent data, then this option must be enabled. When enabled, urgent data is received inline with normal data.

Note, only limited support is provided for handling incoming urgent data. In particular, no notification of incoming urgent data is provided and there is no capability to distinguish between normal data and urgent data unless provided by a higher level protocol.

Specified by:

setOOBInline in interface IceSocket

Overrides:

setOOBInline in class Socket

Parameters:

on - true to enable OOBINLINE, false to disable.

Throws:

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

See Also:

IceSocket.getOOBInline()

setPerformancePreferences

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

Description copied from interface: IceSocket

Sets performance preferences for this socket.

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. Negative values represent a lower priority than positive values. 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 connected will have no effect.

Specified by:

setPerformancePreferences in interface IceSocket

Overrides:

setPerformancePreferences in class Socket

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: IceSocket

Sets the SO_RCVBUF option to the specified value for this Socket . The SO_RCVBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.

Increasing the receive buffer size can increase the performance of network I/O for high-volume connection, while decreasing it can help reduce the backlog of incoming data.

Because SO_RCVBUF is a hint, applications that want to verify what size the buffers were set to should call IceSocket.getReceiveBufferSize().

The value of SO_RCVBUF is also used to set the TCP receive window that is advertized to the remote peer. Generally, the window size can be modified at any time when a socket is connected. However, if a receive window larger than 64K is required then this must be requested before the socket is connected to the remote peer. There are two cases to be aware of:

1. For sockets accepted from a ServerSocket, this must be done by calling ServerSocket.setReceiveBufferSize(int) before the ServerSocket is bound to a local address.

2. For client sockets, setReceiveBufferSize() must be called before connecting the socket to its remote peer.

Specified by:

setReceiveBufferSize in interface IceSocket

Overrides:

setReceiveBufferSize in class Socket

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:

IceSocket.getReceiveBufferSize(), ServerSocket.setReceiveBufferSize(int)

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Description copied from interface: IceSocket

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 IceSocket.bind(SocketAddress) allows the socket to be bound even though a previous connection is in a timeout state.

When a Socket is created the initial setting of SO_REUSEADDR is disabled.

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

Specified by:

setReuseAddress in interface IceSocket

Overrides:

setReuseAddress in class Socket

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:

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

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Description copied from interface: IceSocket

Sets the SO_SNDBUF option to the specified value for this Socket . The SO_SNDBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.

Because SO_SNDBUF is a hint, applications that want to verify what size the buffers were set to should call IceSocket.getSendBufferSize().

Specified by:

setSendBufferSize in interface IceSocket

Overrides:

setSendBufferSize in class Socket

Parameters:

size - the size to which to set the send 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:

IceSocket.getSendBufferSize()

setSoLinger

public void setSoLinger(boolean on,
                        int linger)
                 throws SocketException

Description copied from interface: IceSocket

Enable/disable SO_LINGER with the specified linger time in seconds. The maximum timeout value is platform specific. The setting only affects socket close.

Specified by:

setSoLinger in interface IceSocket

Overrides:

setSoLinger in class Socket

Parameters:

on - whether or not to linger on.

linger - how long to linger for, if on is true.

Throws:

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

See Also:

IceSocket.getSoLinger()

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Description copied from interface: IceSocket

Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a read() call on the InputStream associated with this Socket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException is raised, though the Socket 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 IceSocket

Overrides:

setSoTimeout in class Socket

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:

IceSocket.getSoTimeout()

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException

Description copied from interface: IceSocket

Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

Specified by:

setTcpNoDelay in interface IceSocket

Overrides:

setTcpNoDelay in class Socket

Parameters:

on - true to enable TCP_NODELAY, false to disable.

Throws:

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

See Also:

IceSocket.getTcpNoDelay()

setTrafficClass

public void setTrafficClass(int tc)
                     throws SocketException

Description copied from interface: IceSocket

Sets traffic class or type-of-service octet in the IP header for packets sent from this Socket. As the underlying network implementation may ignore this value applications should consider it a hint.

The tc must be in the range 0 <= tc <= 255 or an IllegalArgumentException will be thrown.

Notes:

For Internet Protocol v4 the value consists of an octet with precedence and TOS fields as detailed in RFC 1349. The TOS field is bitset created by bitwise-or'ing values such the following :-

• IPTOS_LOWCOST (0x02)
• IPTOS_RELIABILITY (0x04)
• IPTOS_THROUGHPUT (0x08)
• IPTOS_LOWDELAY (0x10)

The last low order bit is always ignored as this corresponds to the MBZ (must be zero) bit.

Setting bits in the precedence field may result in a SocketException indicating that the operation is not permitted.

As RFC 1122 section 4.2.4.2 indicates, a compliant TCP implementation should, but is not required to, let application change the TOS field during the lifetime of a connection. So whether the type-of-service field can be changed after the TCP connection has been established depends on the implementation in the underlying platform. Applications should not assume that they can change the TOS field after the connection.

For Internet Protocol v6 tc is the value that would be placed into the sin6_flowinfo field of the IP header.

Specified by:

setTrafficClass in interface IceSocket

Overrides:

setTrafficClass in class Socket

Parameters:

tc - an int value for the bitset.

Throws:

SocketException - if there is an error setting the traffic class or type-of-service

See Also:

IceSocket.getTrafficClass()

shutdownInput

public void shutdownInput()
                   throws IOException

Description copied from interface: IceSocket

Places the input stream for this socket at "end of stream". Any data sent to the input stream side of the socket is acknowledged and then silently discarded.

If you read from a socket input stream after invoking shutdownInput() on the socket, the stream will return EOF.

Specified by:

shutdownInput in interface IceSocket

Overrides:

shutdownInput in class Socket

Throws:

IOException - if an I/O error occurs when shutting down this socket.

See Also:

Socket.shutdownOutput(), Socket.close(), Socket.setSoLinger(boolean, int), IceSocket.isInputShutdown()

shutdownOutput

public void shutdownOutput()
                    throws IOException

Description copied from interface: IceSocket

Disables the output stream for this socket. For a TCP socket, any previously written data will be sent followed by TCP's normal connection termination sequence. If you write to a socket output stream after invoking shutdownOutput() on the socket, the stream will throw an IOException.

Specified by:

shutdownOutput in interface IceSocket

Overrides:

shutdownOutput in class Socket

Throws:

IOException - if an I/O error occurs when shutting down this socket.

See Also:

Socket.shutdownInput(), Socket.close(), Socket.setSoLinger(boolean, int), IceSocket.isOutputShutdown()

socketUDT

public SocketUDT socketUDT()

Description copied from interface: IceCommon

expose underlying socket

Specified by:

socketUDT in interface IceCommon