abs.ixi.client.io

Interface XMPPStream

All Superinterfaces:

ConnectionStateObserver

All Known Implementing Classes:

XMPPStreamManager

public interface XMPPStream
extends ConnectionStateObserver

A facade interface to manage a XMPP stream over a connection. The interface is implemented by XMPPStreamManager

Method Summary

Modifier and Type	Method and Description
void	closeStream() Close the ongoing stream.
void	resetStream() Reset Stream to its initial state.
StreamNegotiator.NegotiationResult	restartStream() Restart a broken stream.
StreamNegotiator.NegotiationResult	startStream(String userName, String pwd, String domain) Start a stream with server with the given user credintials.

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

closed, closingConnection, connected

Method Detail

startStream

StreamNegotiator.NegotiationResult startStream(String userName,
                                               String pwd,
                                               String domain)
                                        throws NetworkException

Start a stream with server with the given user credintials. The assumption is that this stream has never been started before; therefore reader, writer and connection will be used with no change. StreamContext is expected to be in StreamState.INITIATED state. While the negotiation is is progress, 'negotiating' flag is turned on.

Parameters:

userName - userName

pwd - pwd

domain - domain

Returns:

StreamNegotiator.NegotiationResult object

Throws:

NetworkException - if there is any network related error

restartStream

StreamNegotiator.NegotiationResult restartStream()
                                          throws NetworkException

Restart a broken stream. For stream restart, underlying connection is reconnected with server and a new stream is negotiated with the server. The connection uses the previously used ConnectionConfig and user session data to restablish the connection and autentication. Essentially, the broken connection is re-established.

Stream negotiations are done synchronously. The method returns when stream negotiation is finished.

Returns:

NegotiationResult NegotiationResult

Throws:

NetworkException - NetworkException

resetStream

void resetStream()

Reset Stream to its initial state.

closeStream

void closeStream()
          throws NetworkException

Close the ongoing stream. closing a stream does not destroy/offload any object from memory. This is a protocol level action which simply informs server to close the ongoing stream. All the objects along with physical connection with server is kept intact.

Throws:

NetworkException - if an IO error occurrs while sending packet