ch.dermitza.securenio

Class TCPClient

java.lang.Object

ch.dermitza.securenio.AbstractSelector

ch.dermitza.securenio.TCPClient

All Implemented Interfaces:

HandshakeListener, TaskListener, TimeoutListener, java.lang.Runnable

public class TCPClient
extends AbstractSelector

A TCP Client implementation of AbstractSelector. This implementation is purely non-blocking and can handle both PlainSockets and SecureSockets.

Since:

0.18

Field Summary

Fields inherited from class ch.dermitza.securenio.AbstractSelector

address, cipherSuits, container, context, isClient, logger, needClientAuth, pendingData, port, protocols, selector, singleThreaded, taskWorker, toWorker, usingSSL

Constructor Summary

Constructors

Constructor and Description
TCPClient(java.net.InetAddress address, int port, AbstractPacketWorker packetWorker, boolean usingSSL, boolean needClientAuth) Create a TCPClient instance

Method Summary

Methods

Modifier and Type	Method and Description
protected void	accept(java.nio.channels.SelectionKey key) As this is the client implementation, it is NOT allowed to call this method which is only useful for server implementations.
protected void	closeSocket(SocketIF socket) This method overrides the default AbstractSelector.closeSocket(SocketIF) method, to also stop this client from running, as this client implementation only has one associated SocketIF.
protected void	connect(java.nio.channels.SelectionKey key) Finish the connection to the server.
protected void	initConnection() Initialize a client connection.
void	invalidateSession() Invalidate the SSL/TLS session (if any) on the underlying SocketIF.
boolean	isConnected() Returns whether or not this client is connected, if and only if it is running (returns false otherwise).
void	send(PacketIF packet) Send an PacketIF over the this client's SocketIF.

Methods inherited from class ch.dermitza.securenio.AbstractSelector

addListener, handshakeComplete, invalidateSession, isRunning, read, removeListener, run, send, setRunning, setupEngine, setupSSL, taskComplete, timeoutExpired, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPClient

public TCPClient(java.net.InetAddress address,
         int port,
         AbstractPacketWorker packetWorker,
         boolean usingSSL,
         boolean needClientAuth)

Create a TCPClient instance

Parameters:

address - The address to connect to

port - The port to connect to

packetWorker - The instance of packet worker to use

usingSSL - Whether we are using SSL/TLS

needClientAuth - Whether this client should also authenticate with the server.

Method Detail

send

public void send(PacketIF packet)

Send an PacketIF over the this client's SocketIF. Since the client only has one socket, no socket parameter is necessary.

Parameters:

packet - The PacketIF to send through the associated SocketIF.

See Also:

AbstractSelector.send(ch.dermitza.securenio.socket.SocketIF, java.nio.ByteBuffer)

invalidateSession

public void invalidateSession()

Invalidate the SSL/TLS session (if any) on the underlying SocketIF. As this client implementation only has a single socket, no parameter is needed.

See Also:

AbstractSelector.invalidateSession(SocketIF)

initConnection

protected void initConnection()
                       throws java.io.IOException

Initialize a client connection. This method initializes a SocketChannel, configures it to non-blocking, and registers it with the underlying Selector instance with an OP_CONNECT SelectionKey. If this client implementation is using SSL/TLS, it also sets up the SSLEngine, to be used.

Specified by:

initConnection in class AbstractSelector

Throws:

java.io.IOException - Propagates all underlying IOExceptions as thrown, to be handled by the application layer.

See Also:

AbstractSelector.run()

accept

protected void accept(java.nio.channels.SelectionKey key)

As this is the client implementation, it is NOT allowed to call this method which is only useful for server implementations. This implementation will throw a NoSuchMethodError if it is called and do nothing else.

Specified by:

accept in class AbstractSelector

Parameters:

key - The selection key with the underlying SocketChannel to be accepted

See Also:

AbstractSelector.run()

connect

protected void connect(java.nio.channels.SelectionKey key)

Finish the connection to the server. This method also instantiates an SSLEngine handshake if the underlying SocketIF is a secure socket. Finally, after the connection has been established, the socket is registered to the underlying Selector, with a SelectionKey of OP_READ, signalling it is ready to read data.

Specified by:

connect in class AbstractSelector

Parameters:

key - The selection key with the underlying SocketChannel that needs a connection finalization.

isConnected

public boolean isConnected()

Returns whether or not this client is connected, if and only if it is running (returns false otherwise).

Returns:

whether or not this client is connected, if and only if it is running (returns false otherwise)

closeSocket

protected void closeSocket(SocketIF socket)

This method overrides the default AbstractSelector.closeSocket(SocketIF) method, to also stop this client from running, as this client implementation only has one associated SocketIF.

Overrides:

closeSocket in class AbstractSelector

Parameters:

socket - The SocketIF to be closed

See Also:

AbstractSelector.closeSocket(SocketIF)