JBClusterStream Class Reference

A cluster stream. More...

#include <yatejabber.h>

Inheritance diagram for JBClusterStream:

List of all members.

Public Member Functions
	JBClusterStream (JBEngine *engine, Socket *socket)
	JBClusterStream (JBEngine *engine, const JabberID &local, const JabberID &remote, const NamedList *params=0)
virtual JBClusterStream *	clusterStream ()
Protected Member Functions
virtual XmlElement *	buildStreamStart ()
virtual bool	processStart (const XmlElement *xml, const JabberID &from, const JabberID &to)
virtual bool	processRunning (XmlElement *xml, const JabberID &from, const JabberID &to)
Friends
class	JBStream

---

Detailed Description

A cluster stream.

This class holds a cluster stream

---

Constructor & Destructor Documentation

JBClusterStream	(	JBEngine *	engine,
		Socket *	socket
	)

Constructor. Build an incoming stream from a socket

Parameters:

engine	Engine owning this stream
socket	The socket

JBClusterStream	(	JBEngine *	engine,
		const JabberID &	local,
		const JabberID &	remote,
		const NamedList *	params = 0
	)

Constructor. Build an outgoing stream

Parameters:

engine	Engine owning this stream
local	Local party jabber id
remote	Remote party jabber id
params	Optional stream parameters

---

Member Function Documentation

virtual XmlElement* buildStreamStart

(

)

[protected, virtual]

Build a stream start XML element

Returns:

XmlElement pointer

Reimplemented from JBStream.

virtual JBClusterStream* clusterStream

(

)

[inline, virtual]

Get a cluster stream from this one

Returns:

JBClusterStream pointer

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.

---

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

• yatejabber.h