class JBThread

A Jabber thread that can be added to a list of threads. More...

Contains pure virtuals
Full nameTelEngine::JBThread
Definition#include <libs/yjingle/yatejabber.h>
InheritsTelEngine::GenObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods

Protected Methods


Detailed Description

This class holds encapsulates a private library thread

enum Type { StreamConnect, EngineReceive, EngineProcess, Presence, Jingle, Message }

Type

Thread type enumeration. Used to do a specific client processing

 ~JBThread ()

~JBThread

[virtual]

Destructor. Remove itself from the owner's list

inline Type  type ()

type

[const]

Get the type of this thread

Returns: Thread type as enumeration

void  cancelThread (bool hard = false)

cancelThread

[pure virtual]

Cancel (terminate) this thread

Parameters:
hardKill the thread the hard way rather than just setting an exit check marker

bool  start (Type type, JBThreadList* list, void* client, int sleep = 0, int prio = Thread::Normal)

start

[static]

Create and start a private thread

Parameters:
typeThread type
listThe list owning this thread
clientThe client to process
sleepTime to sleep if there is nothing to do, zero to use platform default
prioThread priority, defaults to Normal

Returns: False if failed to start the requested thread

 JBThread (Type type, JBThreadList* owner, void* client, int sleep = 2)

JBThread

[protected]

Constructor. Append itself to the owner's list

Parameters:
typeThread type
ownerThe list owning this thread
clientThe client to process
sleepTime to sleep if there is nothing to do

void  runClient ()

runClient

[protected]

Process the client

inline void*  client ()

client

[protected]

Get the stream's client

Returns: The stream's client


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.