abs.ixi.client.net

Class TCPConnection

java.lang.Object

abs.ixi.client.net.TCPConnection

All Implemented Interfaces:

Identifiable<String>, Connection, AutoCloseable

Direct Known Subclasses:

SFCMConnection, XMPPConnection

public class TCPConnection
extends Object
implements Connection

TCPConnection is a wrapper around SocketChannel; it represents a physical network connection with dsestination host (server). The class keeps the supplied ConnectionConfig which is used to reconnect.

Author:

Yogi

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isConnected

Method Summary

Modifier and Type	Method and Description
void	close() closing a physical connection to the remote machine.
boolean	connect() Establishes a physical connection with destination server.
ConnectionConfig	getConnConfig()
String	getId() Every connection has an unique id assigned.
long	getLastActivity() A byte read/write, connect and disconnect are marked as activity on Connection.
boolean	isConnected() Check if this connection is connected.
int	read(ByteBuffer buffer) Reads incoming data from this connection into the destination buffer
int	write(ByteBuffer buffer) Drains buffer bytes on the underlying connection
void	write(Writable writable) Write Writables onto this connection.

Methods inherited from class java.lang.Object

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

Field Detail

isConnected

protected volatile boolean isConnected

Method Detail

connect

public boolean connect()
                throws IOException

Establishes a physical connection with destination server.

Specified by:

connect in interface Connection

Returns:

true if connection is establishes successfully

Throws:

IOException - IOException

read

public int read(ByteBuffer buffer)
         throws IOException

Description copied from interface: Connection

Reads incoming data from this connection into the destination buffer

Specified by:

read in interface Connection

Parameters:

buffer - buffer

Returns:

int count

Throws:

IOException - IOException

write

public void write(Writable writable)
           throws IOException

Description copied from interface: Connection

Write Writables onto this connection. It is recommended that this method be used to write packet onto a connection. A failure in write will result in socket close.

Specified by:

write in interface Connection

Parameters:

writable - writable

Throws:

IOException - IOException

write

public int write(ByteBuffer buffer)
          throws IOException

Description copied from interface: Connection

Drains buffer bytes on the underlying connection

Specified by:

write in interface Connection

Parameters:

buffer - byte buffer which will drained on underlying socket

Returns:

nnumber of bytes written, possibly zero

Throws:

IOException - if IO error occures while writing data

getConnConfig

public ConnectionConfig getConnConfig()

getId

public String getId()

Description copied from interface: Connection

Every connection has an unique id assigned. Returns id for this Connection

Specified by:

getId in interface Identifiable<String>

Specified by:

getId in interface Connection

isConnected

public boolean isConnected()

Description copied from interface: Connection

Check if this connection is connected. The method just checks the current connection state. With the nature of TCP protocol, it may report a false positive. Without a dial-tone, TCP fails to detect real-time connection state. Without a FIN signal, socket status may not get updated.

The method used to determine connection state in multi-threaded environment; therefore it is advised that implementation of this method is synchronized on the connection object.

Specified by:

isConnected in interface Connection

Returns:

true if the state of underlying connection is connected else false

getLastActivity

public long getLastActivity()

Description copied from interface: Connection

A byte read/write, connect and disconnect are marked as activity on Connection. The method returns time of last activity on this conenction.

Specified by:

getLastActivity in interface Connection

Returns:

long long

close

public void close()
           throws IOException

Description copied from interface: Connection

closing a physical connection to the remote machine.

Specified by:

close in interface Connection

Specified by:

close in interface AutoCloseable

Throws:

IOException - IOException