abs.ixi.client.net

Interface Connection

All Superinterfaces:

AutoCloseable, Identifiable<String>

All Known Subinterfaces:

NegotiatedConnection

All Known Implementing Classes:

SFCMConnection, TCPConnection, XMPPConnection

public interface Connection
extends AutoCloseable, Identifiable<String>

Contract for all the network connections initiated by SDK.Represents a physical connection to a remote host. This interface is protocol agnostic.

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.
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.

Method Detail

getId

String getId()

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

Specified by:

getId in interface Identifiable<String>

connect

boolean connect()
         throws IOException

Establishes a physical connection with destination server.

Returns:

true if connection is establishes successfully

Throws:

IOException - IOException

isConnected

boolean isConnected()

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.

Returns:

true if the state of underlying connection is connected else false

read

int read(ByteBuffer buffer)
  throws IOException

Reads incoming data from this connection into the destination buffer

Parameters:

buffer - buffer

Returns:

int count

Throws:

IOException - IOException

write

int write(ByteBuffer buffer)
   throws IOException

Drains buffer bytes on the underlying 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

write

void write(Writable writable)
    throws IOException

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.

Parameters:

writable - writable

Throws:

IOException - IOException

getLastActivity

long getLastActivity()

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

Returns:

long long

close

void close()
    throws IOException

closing a physical connection to the remote machine.

Specified by:

close in interface AutoCloseable

Throws:

IOException - IOException