JBClientEngine Class Reference

A Jabber client engine. More...

#include <yatejabber.h>

Inheritance diagram for JBClientEngine:

List of all members.

Public Member Functions
	JBClientEngine (const char *name="jbclientengine")
	~JBClientEngine ()
virtual void	cleanup (bool final=false, bool waitTerminate=true)
JBClientStream *	findAccount (const String &account)
JBClientStream *	create (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
JBStreamSetList *	m_receive
JBStreamSetList *	m_process

---

Detailed Description

A Jabber client engine.

This class implements a Jabber client engine

---

Constructor & Destructor Documentation

JBClientEngine

(

const char *

name = "jbclientengine"

)

Constructor

Parameters:

name	Engine name

~JBClientEngine

(

)

Destructor

---

Member Function Documentation

virtual void addStream

(

JBStream *

stream

)

[protected, virtual]

Add a stream to one of the stream lists

Parameters:

stream

The 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:

final	True if called from destructor
waitTerminate	True 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:

account	Account name
params	Stream parameters
name	Optional stream name

Returns:

Referenced JBClientStream pointer or 0 if a stream already exists

JBClientStream* findAccount

(

const String &

account

)

Find a stream by account

Parameters:

account

Account 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:

list	The destination list to set
type	Stream type

Reimplemented from JBEngine.

virtual void removeStream	(	JBStream *	stream,
		bool	delObj = true
	)		[protected, virtual]

Remove a stream

Parameters:

stream	The stream to remove
delObj	True 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:

waitTerminate

True to wait for all streams to terminate

Reimplemented from JBEngine.

---

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

• yatejabber.h