ConnectionListener Class Reference

Derived classes can be registered as ConnectionListeners with the Client. More...

#include <connectionlistener.h>

List of all members.

Public Member Functions

virtual ~ConnectionListener ()
virtual void onConnect ()=0
virtual void onDisconnect (ConnectionError e)=0
virtual void onResourceBindError (ResourceBindError error)
virtual void onSessionCreateError (SessionCreateError error)
virtual bool onTLSConnect (const CertInfo &info)=0


Detailed Description

Derived classes can be registered as ConnectionListeners with the Client.

This interface is mandatory to implement if a connection is to be made TLS-encrypted. In onTLSConnect(), the server's certificate information needs to be checked, and true returned if the certificate is to be accepted.

Author:
Jakob Schroeter <js@camaya.net>

Definition at line 31 of file connectionlistener.h.


Constructor & Destructor Documentation

virtual ~ConnectionListener (  )  [inline, virtual]

Virtual Destructor.

Definition at line 37 of file connectionlistener.h.


Member Function Documentation

virtual void onConnect (  )  [pure virtual]

This function notifies about successful connections. It will be called either after all authentication is finished if username/password were supplied, or after a connection has been established if no credentials were supplied. Depending on the setting of AutoPresence, a presence stanza is sent or not.

virtual void onDisconnect ( ConnectionError  e  )  [pure virtual]

This function notifies about disconnection and its reason. If e indicates a stream error, you can use ClientBase::streamError() to find out what exactly went wrong, and ClientBase::streamErrorText() to retrieve any explaining text sent along with the error. If e indicates an authentication error, you can use ClientBase::authError() to get a finer grained reason.

Parameters:
e The reason for the disconnection.

virtual void onResourceBindError ( ResourceBindError  error  )  [inline, virtual]

This function is called (by a Client object) if an error occurs while trying to bind a resource.

Parameters:
error Describes the error condition.

Definition at line 62 of file connectionlistener.h.

virtual void onSessionCreateError ( SessionCreateError  error  )  [inline, virtual]

This function is called (by a Client object) if an error occurs while trying to establish a session.

Parameters:
error Describes the error condition.

Definition at line 69 of file connectionlistener.h.

virtual bool onTLSConnect ( const CertInfo info  )  [pure virtual]

This function is called when the connection was TLS/SSL secured.

Parameters:
info Comprehensive info on the certificate.
Returns:
True if cert credentials are accepted, false otherwise. If false is returned the connection is terminated.


The documentation for this class was generated from the following file:
Generated on Tue May 1 14:20:22 2007 for gloox by  doxygen 1.5.1