Yate
Public Member Functions | Protected Member Functions | Friends
JBClusterStream Class Reference

A cluster stream. More...

#include <yatejabber.h>

Inheritance diagram for JBClusterStream:
JBStream RefObject DebugEnabler Mutex GenObject Lockable

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 JBClusterStreamclusterStream ()

Protected Member Functions

virtual XmlElementbuildStreamStart ()
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:
engineEngine owning this stream
socketThe socket
JBClusterStream ( JBEngine engine,
const JabberID local,
const JabberID remote,
const NamedList params = 0 
)

Constructor. Build an outgoing stream

Parameters:
engineEngine owning this stream
localLocal party jabber id
remoteRemote party jabber id
paramsOptional 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:
xmlReceived element (will be consumed)
fromAlready parsed source JID
toAlready 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:
xmlReceived xml element
fromThe 'from' attribute
toThe 'to' attribute
Returns:
False if stream termination was initiated

Reimplemented from JBStream.


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