class JBService

A Jabber service. More...

Full nameTelEngine::JBService
Definition#include <libs/yjingle/yatejabber.h>
InheritsTelEngine::DebugEnabler [public ], TelEngine::GenObject [public ], TelEngine::Mutex [public ]
Inherited byJBMessage, JBPresence, JGEngine
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


Detailed Description

This class is the base class for a Jabber service who wants to get specific protocol data from the Jabber engine

 JBService (JBEngine* engine, const char* name, const NamedList* params, int prio)

JBService

Constructor

Parameters:
engineThe Jabber engine
nameThis service's name
paramsService's parameters
prioThe priority of this service

 ~JBService ()

~JBService

[virtual]

Destructor. Remove from engine

inline JBEngine*  engine ()

engine

Get the Jabber engine

Returns: The Jabber engine

inline int  priority ()

priority

[const]

Get the Jabber engine

Returns: The Jabber engine

bool  received (JBEvent* event)

received

Accept an event from the engine. If accepted, the event is enqueued and the stream that generated the event is notified on event terminated to allow it to process other data. This method is thread safe

Parameters:
eventThe event to accept

Returns: False if not accepted, let the engine try another service

void  initialize (const NamedList& params)

initialize

[virtual]

Initialize the service

Parameters:
paramsService's parameters

void  destruct ()

destruct

[virtual]

Remove from engine. Release memory

Reimplemented from GenObject.

bool  accept (JBEvent* event, bool& processed, bool& insert)

accept

[protected virtual]

Accept an event from the engine

Parameters:
eventThe event to accept
processedSet to true on exit to signal that the event was already processed
insertSet to true if accepted to insert on top of the event queue

Returns: False if not accepted, let the engine try another service

JBEvent*  deque ()

deque

[protected]

Get an event from queue

Returns: JBEvent pointer or 0 if queue is empty

bool m_initialized

m_initialized

[protected]


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.