class JBClusterStream

A cluster stream. More...

Full nameTelEngine::JBClusterStream
Definition#include <libs/yjabber/yatejabber.h>
InheritsTelEngine::JBStream [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

This class holds a cluster stream

 JBClusterStream (JBEngine* engine, Socket* socket)

JBClusterStream

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)

JBClusterStream

Constructor. Build an outgoing stream

Parameters:
engineEngine owning this stream
localLocal party jabber id
remoteRemote party jabber id
paramsOptional stream parameters

JBClusterStream*  clusterStream ()

clusterStream

[virtual]

Get a cluster stream from this one

Returns: JBClusterStream pointer

Reimplemented from JBStream.

XmlElement*  buildStreamStart ()

buildStreamStart

[protected virtual]

Build a stream start XML element

Returns: XmlElement pointer

Reimplemented from JBStream.

bool  processStart (const XmlElement* xml, const JabberID& from, const JabberID& to)

processStart

[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.

bool  processRunning (XmlElement* xml, const JabberID& from, const JabberID& to)

processRunning

[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.


Generated by: paulc on bussard on Mon Feb 10 13:15:47 2014, using kdoc 2.0a54.