ISocket (NetPhantom® 7.7 Java API Specification)

All Known Implementing Classes:

SocketAdapter
```
public interface ISocket
```
Interface to access the socket class.

Author:

Christopher Mindus

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this socket.
`void`	`doSynchronousSSLHandshake(int timeout)` Performs a "read" on the SSLSocket without removing it from the input stream.
`InetAddress`	`getInetAddress()` Returns the address to which the socket is connected.
`InputStream`	`getInputStream()` Returns an input stream for this socket.
`InetAddress`	`getLocalAddress()` Gets the local address to which the socket is bound.
`int`	`getLocalPort()` Returns the local port number 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.
`OutputStream`	`getOutputStream()` Returns an output stream for this socket.
`int`	`getPort()` Returns the remote port number to which this socket is connected.
`SocketAddress`	`getRemoteSocketAddress()` Returns the address of the endpoint this socket is connected to, or `null` if it is unconnected.
`int`	`getSoTimeout()` Returns setting for SO_TIMEOUT.
`SSLSocket`	`getSSLSocket()` Gets the underlying SSLSocket.
`boolean`	`getTcpNoDelay()` Tests if TCP_NODELAY is enabled.
`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.
`boolean`	`isSSLSocket()` Checks if this is an SSL socket.
`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`	`shutdownInput()` Places the input stream for this socket at "end of stream".
`void`	`shutdownOutput()` Disables the output stream for this socket.

- Method Detail
  - getInetAddress
```
InetAddress getInetAddress()
```
    Returns the address to which the socket is connected.
    If the socket was connected prior to being closed, then this method will continue to return the connected address after the socket is closed.
    
    Returns:
    
    the remote IP address to which this socket is connected, or null if the socket is not connected.
  - getLocalAddress
```
InetAddress getLocalAddress()
```
    Gets the local address to which the socket is bound.
    
    Returns:
    
    the local address to which the socket is bound, or the wildcard address if the socket is closed or not bound yet.
  - getPort
```
int getPort()
```
    Returns the remote port number to which this socket is connected.
    If the socket was connected prior to being closed, then this method will continue to return the connected port number after the socket is closed.
    
    Returns:
    
    the remote port number to which this socket is connected, or 0 if the socket is not connected yet.
  - getLocalPort
```
int getLocalPort()
```
    Returns the local port number to which this socket is bound.
    If the socket was bound prior to being closed, then this method will continue to return the local port number after the socket is closed.
    
    Returns:
    
    the local port number to which this socket is bound or -1 if the socket is not bound yet.
  - getRemoteSocketAddress
```
SocketAddress getRemoteSocketAddress()
```
    Returns the address of the endpoint this socket is connected to, or null if it is unconnected.
    If the socket was connected prior to being closed, then this method will continue to return the connected address after the socket is closed.
    
    Returns:
    
    a SocketAddress representing the remote endpoint of this socket, or null if it is not connected yet.
  - getLocalSocketAddress
```
SocketAddress getLocalSocketAddress()
```
    Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
    If a socket bound to an endpoint represented by an InetSocketAddress is closed, then this method will continue to return an InetSocketAddress after the socket is closed. In that case the returned InetSocketAddress's address is the wildcard address and its port is the local port that it was bound to.
    
    Returns:
    
    a SocketAddress representing the local endpoint of this socket, or null if it is not bound yet.
  - getInputStream
```
InputStream getInputStream()
                    throws IOException
```
    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.
    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 shutdownInput()
  - getOutputStream
```
OutputStream getOutputStream()
                      throws IOException
```
    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.
    
    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.
  - setSoTimeout
```
void setSoTimeout(int timeout)
           throws SocketException
```
    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.
    
    Parameters:
    
    timeout - the specified timeout, in milliseconds.
    
    Throws:
    
    SocketException - if there is an error in the underlying protocol, such as a TCP error.
  - getSoTimeout
```
int getSoTimeout()
          throws SocketException
```
    Returns setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).
    
    Returns:
    
    the setting for SO_TIMEOUT
    
    Throws:
    
    SocketException - if there is an error in the underlying protocol, such as a TCP error.
  - setTcpNoDelay
```
void setTcpNoDelay(boolean on)
            throws SocketException
```
    Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
    
    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.
    
    Since:
    
    JDK1.1
    
    See Also:
    
    getTcpNoDelay()
  - getTcpNoDelay
```
boolean getTcpNoDelay()
               throws SocketException
```
    Tests if TCP_NODELAY is enabled.
    
    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.
  - close
```
void close()
    throws IOException
```
    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.
    
    Throws:
    
    IOException - if an I/O error occurs when closing this socket.
  - shutdownInput
```
void shutdownInput()
            throws IOException
```
    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.
    
    Throws:
    
    IOException - if an I/O error occurs when shutting down this socket.
  - shutdownOutput
```
void shutdownOutput()
             throws IOException
```
    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.
    
    Throws:
    
    IOException - if an I/O error occurs when shutting down this socket.
  - isConnected
```
boolean isConnected()
```
    Returns the connection state of the socket.
    Note: Closing a socket doesn't clear its connection state, which means this method will return true for a closed socket (see isClosed()) if it was successfully connected prior to being closed.
    
    Returns:
    
    true if the socket was successfully connected to a server
  - isBound
```
boolean isBound()
```
    Returns the binding state of the socket.
    Note: Closing a socket doesn't clear its binding state, which means this method will return true for a closed socket (see isClosed()) if it was successfully bound prior to being closed.
    
    Returns:
    
    true if the socket was successfully bound to an address
  - isClosed
```
boolean isClosed()
```
    Returns the closed state of the socket.
    
    Returns:
    
    true if the socket has been closed
  - isInputShutdown
```
boolean isInputShutdown()
```
    Returns whether the read-half of the socket connection is closed.
    
    Returns:
    
    true if the input of the socket has been shutdown
  - isOutputShutdown
```
boolean isOutputShutdown()
```
    Returns whether the write-half of the socket connection is closed.
    
    Returns:
    
    true if the output of the socket has been shutdown
  - isSSLSocket
```
boolean isSSLSocket()
```
    Checks if this is an SSL socket.
  - getSSLSocket
```
SSLSocket getSSLSocket()
```
    Gets the underlying SSLSocket.
    
    Returns:
    
    null for non-SSL sockets.
  - doSynchronousSSLHandshake
```
void doSynchronousSSLHandshake(int timeout)
                        throws IOException
```
    Performs a "read" on the SSLSocket without removing it from the input stream. This will only work on an SSLSocket, do not call otherwise.
    
    Parameters:
    
    timeout - Time in milliseconds to complete the handshake.
    
    Throws:
    
    IOException - In case of socket errors.

Interface ISocket

Method Summary

Method Detail

getInetAddress

getLocalAddress

getPort

getLocalPort

getRemoteSocketAddress

getLocalSocketAddress

getInputStream

getOutputStream

setSoTimeout

getSoTimeout

setTcpNoDelay

getTcpNoDelay

close

shutdownInput

shutdownOutput

isConnected

isBound

isClosed

isInputShutdown

isOutputShutdown

isSSLSocket

getSSLSocket

doSynchronousSSLHandshake