MessageFrameListProvider Class Reference

#include <xmppbase.h>

Inheritance diagram for MessageFrameListProvider:

[legend]Collaboration diagram for MessageFrameListProvider:

[legend]List of all members.

Protected Member Functions
virtual void	ProcessRemoteNodeWantsMessageFrame (MessageFrame *newFrame, PString &remoteController)
virtual MessageFrame *	BuildMessageFrame ()
void	MakeNewMessageFrames (PThread &, INT param)
void	TransferMessageFrames (PThread &, INT param)
Protected Attributes
PThread *	makeNewMessageFrame
PSyncPoint	makeAnother
PThread *	transferMessageFrames
PSyncPoint	transferFrame
BOOL	keepGoing
NodeRequest	pendingRequests
LaunchNewId &	lid

---

Detailed Description

A class that extends MessageFrameList by adding a thread to create, ahead of time, MessageFrame instances, that are initialised with the remote server and are all ready to go

---

Member Function Documentation

MessageFrame * MessageFrameListProvider::BuildMessageFrame (   )  [protected, virtual]

Do the work of actually building a new MessageFrame Reimplemented in CommsProvider.

void MessageFrameListProvider::MakeNewMessageFrames (  PThread &  , INT  param )  [protected]

The thread, which runs to create new and ready to go instances, runs in here

void MessageFrameListProvider::ProcessRemoteNodeWantsMessageFrame (  MessageFrame *  newFrame, PString &  remoteController )  [protected, virtual]

A descendant of this class will override this method. On detecting that a remote node wants a MessageFrame, this method is called. The descendant class will have the ability to take the supplied frame and hand it to the correct destination. Only the thread that runs inside this list will call this method.

void MessageFrameListProvider::TransferMessageFrames (  PThread &  , INT  param )  [protected]

The thread, which runs to transfer built frames to the pre call list

---

Member Data Documentation

BOOL MessageFrameListProvider::keepGoing [protected]

A flag to indicate it is time to end this thread Reimplemented from MessageFrame.

LaunchNewId& MessageFrameListProvider::lid [protected]

Reference to the LaunchNewId class, which is required for building Comms classes Reimplemented from MessageFrame.

PSyncPoint MessageFrameListProvider::makeAnother [protected]

The flag which we use to indicate to the makeNewMessageFrame thread that it is time to build a new frame

PThread* MessageFrameListProvider::makeNewMessageFrame [protected]

The thread which will create new instances of MessageFrame structures, as required

NodeRequest MessageFrameListProvider::pendingRequests [protected]

Store the list of pending node requests here

PSyncPoint MessageFrameListProvider::transferFrame [protected]

The flag which we use to indicate to the transferMessageFrame thread that it is time to transfer a message frame

PThread* MessageFrameListProvider::transferMessageFrames [protected]

The thread which will transfer the created instances of MessageFrame structures, as required

---

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

• xmppbase.h
• xmppbase.cxx

---