ClientSocket (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- com.netphantom.server.utils.ClientSocket

All Implemented Interfaces:
EventListener, HandshakeCompletedListener
```
public class ClientSocket
extends Object
implements HandshakeCompletedListener
```
The client socket class is a direct replacement for the Socket class and supports plain or SSL connections. It is mainly used by the Telnet engine for host connections.
Author:
Christopher Mindus

Constructor Summary

Constructors
Constructor and Description
`ClientSocket(String host, int port, InetAddress inaBind)` Creates a new plain socket connection with INI file settings.
`ClientSocket(String host, int port, InetAddress inaBind, SSLParams params)` Creates a new plain or secured socket connection with SSL `params`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the socket.
`InputStream`	`getInputStream()` Gets the input stream of the socket.
`OutputStream`	`getOutputStream()` Gets the output stream of the socket.
`X509Certificate`	`getServerCertificate()` Gets the server certificate.
`void`	`handshakeCompleted(HandshakeCompletedEvent event)` Called when handshake has completed.
`void`	`setSoTimeout(int timeout)` Sets the socket timeout.
`void`	`setTcpNoDelay(boolean on)` Sets the NO DELAY option for socket.

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

- Constructor Detail
  - ClientSocket
```
public ClientSocket(String host,
                    int port,
                    InetAddress inaBind)
             throws IOException
```
    Creates a new plain socket connection with INI file settings.
    Parameters:
    host - The host name or address.
    port - The destination port.
    inaBind - The bind address on the local machine to use, or null for none.
    Throws:
    IOException - For socket errors.
  - ClientSocket
```
public ClientSocket(String host,
                    int port,
                    InetAddress inaBind,
                    SSLParams params)
             throws IOException
```
    Creates a new plain or secured socket connection with SSL params.
    Parameters:
    host - The host name or address.
    port - The destination port.
    inaBind - The bind address on the local machine to use or null for none.
    params - The SSL parameters instance for a secured socket, or null for a plain socket.
    Throws:
    IOException - For socket errors.
- Method Detail
  - handshakeCompleted
```
public void handshakeCompleted(HandshakeCompletedEvent event)
```
    Called when handshake has completed.
    Specified by:
    handshakeCompleted in interface HandshakeCompletedListener
    Parameters:
    event - Event for completion of handshake.
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean on)
                   throws SocketException
```
    Sets the NO DELAY option for socket.
    Throws:
    SocketException - For socket errors.
  - setSoTimeout
```
public void setSoTimeout(int timeout)
                  throws SocketException
```
    Sets the socket timeout.
    Throws:
    SocketException - For socket errors.
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Gets the input stream of the socket.
    Returns:
    The input stream.
    Throws:
    IOException - For socket errors.
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Gets the output stream of the socket.
    Returns:
    The output stream.
    Throws:
    IOException - For socket errors.
  - close
```
public void close()
           throws IOException
```
    Closes the socket.
    Throws:
    IOException - For socket errors.
  - getServerCertificate
```
public X509Certificate getServerCertificate()
```
    Gets the server certificate.
    Returns:
    The server certificate or null if none is present.

Class ClientSocket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientSocket

ClientSocket

Method Detail

handshakeCompleted

setTcpNoDelay

setSoTimeout

getInputStream

getOutputStream

close

getServerCertificate