JBClientStream Class Reference

A client to server stream. More...

#include <yatejabber.h>

Inheritance diagram for JBClientStream:

List of all members.

Public Member Functions
	JBClientStream (JBEngine *engine, Socket *socket, bool ssl=false)
	JBClientStream (JBEngine *engine, const JabberID &jid, const String &account, const NamedList &params, const char *name=0, const char *serverHost=0)
const String &	account () const
GenObject *	userData ()
void	userData (GenObject *data)
virtual JBClientStream *	clientStream ()
void	bind (const String &resource, const char *id, XMPPError::Type error=XMPPError::NoError)
bool	requestRegister (bool data, bool set=true, const String &newPass=String::empty())
Protected Member Functions
virtual bool	processRunning (XmlElement *xml, const JabberID &from, const JabberID &to)
virtual bool	processStart (const XmlElement *xml, const JabberID &from, const JabberID &to)
virtual bool	processAuth (XmlElement *xml, const JabberID &from, const JabberID &to)
virtual bool	processRegister (XmlElement *xml, const JabberID &from, const JabberID &to)
virtual void	destroyed ()
bool	startAuth ()
bool	bind ()
Friends
class	JBStream

---

Detailed Description

A client to server stream.

This class holds a client to server stream

---

Constructor & Destructor Documentation

JBClientStream	(	JBEngine *	engine,
		Socket *	socket,
		bool	ssl = false
	)

Constructor. Build an incoming stream from a socket

Parameters:

engine	Engine owning this stream
socket	The socket
ssl	True if the socket is already using SSL/TLS

JBClientStream	(	JBEngine *	engine,
		const JabberID &	jid,
		const String &	account,
		const NamedList &	params,
		const char *	name = 0,
		const char *	serverHost = 0
	)

Constructor. Build an outgoing stream

Parameters:

engine	Engine owning this stream
jid	User jid
account	Account (stream) name
params	Stream parameters
name	Optional stream name
serverHost	Optional server host to use instead of jid domain

---

Member Function Documentation

const String& account

(

)

const [inline]

Retrieve stream's account

Returns:

Stream account

void bind	(	const String &	resource,
		const char *	id,
		XMPPError::Type	error = XMPPError::NoError
	)

Bind a resource to an incoming stream. This method should be called after processing a Bind event This method is thread safe

Parameters:

resource	Resource to bind. Empty on error
id	Received bind request id
error	Failure reason. Ignored on success

bool bind

(

)

[protected]

Start resource binding on outgoing stream

Returns:

True on success

virtual JBClientStream* clientStream

(

)

[inline, virtual]

Get a client stream from this one

Returns:

JBClientStream pointer

Reimplemented from JBStream.

virtual void destroyed

(

)

[protected, virtual]

Release memory

Reimplemented from JBStream.

virtual bool processAuth	(	XmlElement *	xml,
		const JabberID &	from,
		const JabberID &	to
	)		[protected, virtual]

Process elements in Auth state

Parameters:

xml	Received element (will be consumed)
from	Already parsed source JID
to	Already parsed destination JID

Returns:

False if stream termination was initiated

Reimplemented from JBStream.

virtual bool processRegister	(	XmlElement *	xml,
		const JabberID &	from,
		const JabberID &	to
	)		[protected, virtual]

Process elements in Register state

Parameters:

xml	Received element (will be consumed)
from	Already parsed source JID
to	Already parsed destination JID

Returns:

False if stream termination was initiated

Reimplemented from JBStream.

virtual bool processRunning	(	XmlElement *	xml,
		const JabberID &	from,
		const JabberID &	to
	)		[protected, virtual]

Process elements in Running state

Parameters:

xml	Received element (will be consumed)
from	Already parsed source JID
to	Already parsed destination JID

Returns:

False if stream termination was initiated

Reimplemented from JBStream.

virtual bool processStart	(	const XmlElement *	xml,
		const JabberID &	from,
		const JabberID &	to
	)		[protected, virtual]

Process stream start elements while waiting for them

Parameters:

xml	Received xml element
from	The 'from' attribute
to	The 'to' attribute

Returns:

False if stream termination was initiated

Reimplemented from JBStream.

bool requestRegister	(	bool	data,
		bool	set = true,
		const String &	newPass = String::empty()
	)

Request account register or change on outgoing stream. This method is thread safe

Parameters:

data	True to request registration/change, false to request info
set	True to request new user registration, false to remove account from server
newPass	New password when requesting account setup on an already authenticated stream

Returns:

True on success

bool startAuth

(

)

[protected]

Start outgoing stream authentication

Returns:

True on success

GenObject* userData

(

)

[inline]

Retrieve stream's user data

Returns:

GenObject pointer or 0

void userData

(

GenObject *

data

)

[inline]

Set stream's user data. Transfer data ownership to the stream This method is thread safe

Parameters:

data	Data to set

References TelEngine::destruct().

---

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

• yatejabber.h