Yate
Public Member Functions | Protected Member Functions | Protected Attributes
JBClientEngine Class Reference

A Jabber client engine. More...

#include <yatejabber.h>

Inheritance diagram for JBClientEngine:
JBEngine DebugEnabler Mutex GenObject Lockable

List of all members.

Public Member Functions

 JBClientEngine (const char *name="jbclientengine")
 ~JBClientEngine ()
virtual void cleanup (bool final=false, bool waitTerminate=true)
JBClientStreamfindAccount (const String &account)
JBClientStreamcreate (const String &account, const NamedList &params, const String &name=String::empty())
virtual void getStreamList (RefPointer< JBStreamSetList > &list, int type)

Protected Member Functions

virtual void addStream (JBStream *stream)
virtual void removeStream (JBStream *stream, bool delObj=true)
virtual void stopStreamSets (bool waitTerminate=true)

Protected Attributes

JBStreamSetListm_receive
JBStreamSetListm_process

Detailed Description

A Jabber client engine.

This class implements a Jabber client engine


Constructor & Destructor Documentation

JBClientEngine ( const char *  name = "jbclientengine")

Constructor

Parameters:
nameEngine name

Destructor


Member Function Documentation

virtual void addStream ( JBStream stream) [protected, virtual]

Add a stream to one of the stream lists

Parameters:
streamThe stream to add

Reimplemented from JBEngine.

virtual void cleanup ( bool  final = false,
bool  waitTerminate = true 
) [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* create ( const String account,
const NamedList params,
const String name = String::empty() 
)

Build an outgoing client stream

Parameters:
accountAccount name
paramsStream parameters
nameOptional stream name
Returns:
Referenced JBClientStream pointer or 0 if a stream already exists
JBClientStream* findAccount ( const String account)

Find a stream by account

Parameters:
accountAccount name
Returns:
Referenced JBClientStream pointer or 0
virtual void getStreamList ( RefPointer< JBStreamSetList > &  list,
int  type 
) [virtual]

Retrieve the list of streams of a given type

Parameters:
listThe destination list to set
typeStream type

Reimplemented from JBEngine.

virtual void removeStream ( JBStream stream,
bool  delObj = true 
) [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.

virtual void stopStreamSets ( bool  waitTerminate = true) [protected, virtual]

Stop all stream sets

Parameters:
waitTerminateTrue to wait for all streams to terminate

Reimplemented from JBEngine.


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