class JBClientEngine

A Jabber client engine. More...

Full nameTelEngine::JBClientEngine
Definition#include <libs/yjabber/yatejabber.h>
InheritsTelEngine::JBEngine [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


Detailed Description

This class implements a Jabber client engine

 JBClientEngine (const char* name = "jbclientengine")

JBClientEngine

Constructor

Parameters:
nameEngine name

 ~JBClientEngine ()

~JBClientEngine

Destructor

void  cleanup (bool final = false, bool waitTerminate = true)

cleanup

[virtual]

Terminate all streams. Stop all sets processors. Release memory if final

Parameters:
finalTrue if called from destructor
waitTerminateTrue to wait for all streams to terminate

Reimplemented from JBEngine.

JBClientStream*  findAccount (const String& account)

findAccount

Find a stream by account

Parameters:
accountAccount name

Returns: Referenced JBClientStream pointer or 0

JBClientStream*  create (const String& account, const NamedList& params, const String& name = String::empty())

create

Build an outgoing client stream

Parameters:
accountAccount name
paramsStream parameters
nameOptional stream name

Returns: Referenced JBClientStream pointer or 0 if a stream already exists

void  getStreamList (RefPointer& list, int type)

getStreamList

[virtual]

Retrieve the list of streams of a given type

Parameters:
listThe destination list to set
typeStream type

Reimplemented from JBEngine.

void  addStream (JBStream* stream)

addStream

[protected virtual]

Add a stream to one of the stream lists

Parameters:
streamThe stream to add

Reimplemented from JBEngine.

void  removeStream (JBStream* stream, bool delObj = true)

removeStream

[protected virtual]

Remove a stream

Parameters:
streamThe stream to remove
delObjTrue to release the stream, false to remove it from list without releasing it

Reimplemented from JBEngine.

void  stopStreamSets (bool waitTerminate = true)

stopStreamSets

[protected virtual]

Stop all stream sets

Parameters:
waitTerminateTrue to wait for all streams to terminate

Reimplemented from JBEngine.

JBStreamSetList* m_receive

m_receive

[protected]

JBStreamSetList* m_process

m_process

[protected]


Generated by: paulc on bussard on Sun Oct 20 21:06:06 2013, using kdoc 2.0a54.