abs.ixi.client.net

Class XMPPConnection

java.lang.Object

abs.ixi.client.net.TCPConnection

abs.ixi.client.net.XMPPConnection

All Implemented Interfaces:

Identifiable<String>, Connection, NegotiatedConnection, AutoCloseable

public class XMPPConnection
extends TCPConnection
implements NegotiatedConnection

An extension of TCPConnection with semenatics of XMPP protocol such as reply timeout for packets.

The class does not have a public constructor; use ConnectionManager to instantiate XMPPConnection.

Author:

Yogi

Field Summary

Fields inherited from class abs.ixi.client.net.TCPConnection

isConnected

Method Summary

Modifier and Type	Method and Description
void	clearAuthenticatedStatus()
void	close() closing a physical connection to the remote machine.
String	getId() Every connection has an unique id assigned.
Duration	getReplyTimeout()
XMPPStream	getXmppStream()
boolean	isAuthenticated()
boolean	isNegotiated() Connection implementation with protocol semantics, generally, involves negotiating a packet stream; for example XMPP connections requires XMPP stream to be negotiated before user packets can be sent/received on the connection.
void	markAuthenticated() Mark this connection status authenticated
void	negotiationComplete() Set negotiation state to complete for this connection
int	read(ByteBuffer buffer) Reads incoming data from this connection into the destination buffer
void	setXmppStream(XMPPStream xmppStream)
String	toString()
int	write(ByteBuffer buffer) Drains buffer bytes on the underlying connection
void	write(Packet packet)

Methods inherited from class abs.ixi.client.net.TCPConnection

connect, getConnConfig, getLastActivity, isConnected, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface abs.ixi.client.net.Connection

connect, getLastActivity, isConnected, write

Method Detail

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

Overrides:

read in class TCPConnection

Parameters:

buffer - buffer

Returns:

int count

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

Overrides:

write in class TCPConnection

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

getReplyTimeout

public Duration getReplyTimeout()

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

Overrides:

close in class TCPConnection

Throws:

IOException - IOException

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

Overrides:

getId in class TCPConnection

toString

public String toString()

Overrides:

toString in class Object

write

public void write(Packet packet)
           throws IOException

Throws:

IOException

getXmppStream

public XMPPStream getXmppStream()

setXmppStream

public void setXmppStream(XMPPStream xmppStream)

isNegotiated

public boolean isNegotiated()

Description copied from interface: NegotiatedConnection

Connection implementation with protocol semantics, generally, involves negotiating a packet stream; for example XMPP connections requires XMPP stream to be negotiated before user packets can be sent/received on the connection.

Specified by:

isNegotiated in interface NegotiatedConnection

Returns:

true or false

negotiationComplete

public void negotiationComplete()

Description copied from interface: NegotiatedConnection

Set negotiation state to complete for this connection

Specified by:

negotiationComplete in interface NegotiatedConnection

markAuthenticated

public void markAuthenticated()

Mark this connection status authenticated

clearAuthenticatedStatus

public void clearAuthenticatedStatus()

isAuthenticated

public boolean isAuthenticated()