glooxd  0.3-svn
Public Member Functions | List of all members
ServerEventHandler Class Reference

#include <servereventhandler.h>

Public Member Functions

virtual ~ServerEventHandler ()
virtual void handleC2SListening (bool yes)
virtual void handleS2SListening (bool yes)
virtual void handleClientConnected (const gloox::JID jid, const std::string localIP, int localPort, const std::string remoteIP, int remotePort)
virtual void handleClientDisconnected (const gloox::JID jid, gloox::ConnectionError e, gloox::StreamError se)

Detailed Description

An interface that can be re-implemented to receive server events.

Author
Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net
Since
0.2

Definition at line 33 of file servereventhandler.h.

Constructor & Destructor Documentation

virtual ~ServerEventHandler ( )
inlinevirtual

Virtual destructor.

Definition at line 39 of file servereventhandler.h.

Member Function Documentation

virtual void handleC2SListening ( bool  yes)
inlinevirtual

This function is called with an parameter of true exactly once when one or more s2s interfaces have been added. I.e. it is called when the number of listening interfaces is exactly 1. It is called with a parameter of false when interfaces have been removed and the number of listening interfaces is now exactly 0.

Parameters
yesWhether or not there is at least one listening interface.

Definition at line 52 of file servereventhandler.h.

virtual void handleClientConnected ( const gloox::JID  jid,
const std::string  localIP,
int  localPort,
const std::string  remoteIP,
int  remotePort 
)
inlinevirtual

This function is called when a client connected, authenticated, and requested creation of a session.

Parameters
jidThe client's full JID.
localIPThe local IP the client connected to.
localPortThe local port the client connected to.
remoteIPThe remote IP the client connected from.
remotePortThe remote port the client connected from.

Definition at line 76 of file servereventhandler.h.

virtual void handleClientDisconnected ( const gloox::JID  jid,
gloox::ConnectionError  e,
gloox::StreamError  se 
)
inlinevirtual

This function is called when a client disconnected or got disconnected. It will only be called for client connections that handleClientConnected() has been called for previously.

Parameters
jidThe client's full JID.
eA connection error.
seA stanza error.

Definition at line 95 of file servereventhandler.h.

virtual void handleS2SListening ( bool  yes)
inlinevirtual

This function is called with an parameter of true exactly once when one or more s2s interfaces have been added. I.e. it is called when the number of listening interfaces is exactly 1. It is called with a parameter of false when interfaces have been removed and the number of listening interfaces is now exactly 0.

Parameters
yesWhether or not there is at least one listening interface.

Definition at line 65 of file servereventhandler.h.


The documentation for this class was generated from the following file: