Message Building and Parsing

Collaboration diagram for Message Building and Parsing:

Files
file	FountainMessage.h
	Definitions of classes FountainMessage and FountainParseMessage.
file	NodeMessage.h
	Definitions of classes NodeMessage, NodeRequest, and NodeResponse.
file	ServerMessage.h
	Definitions of classes ServerMessage, ServerRequest, and ServerResponse.
Classes
class	NodeMessage
	Abstract base class for messages sent to and from Fountain nodes. More...
class	NodeRequest
	Used for request messages sent from a Fountain node. More...
class	NodeResponse
	Used for response messages sent from a Fountain node. More...
class	ServerMessage
	Abstract base class for messages sent to and from the Fountain server. More...
class	ServerRequest
	Used for request messages sent from the Fountain server. More...
class	ServerResponse
	Used for response messages sent from the Fountain server. More...
class	FountainMessage
	Base class for building all messages exchanged between Fountain nodes, server, and clients. More...
class	FountainParseMessage
	simple wrapper class around the bamboo library ParseMsg class More...
Typedefs
typedef Loki::SmartPtr< NodeRequest >	NodeRequestPtr
	SmartPtr object utilizing SmartPtr's default policies wrapped around a NodeRequest pointer.
typedef Loki::SmartPtr< NodeResponse >	NodeResponsePtr
	SmartPtr object utilizing SmartPtr's default policies wrapped around a NodeResponse pointer.
typedef Loki::SmartPtr< ServerResponse >	ServerResponsePtr
	SmartPtr object utilizing SmartPtr's default policies wrapped around a ServerResponse pointer.
typedef Loki::SmartPtr< ServerRequest >	ServerRequestPtr
	SmartPtr object utilizing SmartPtr's default policies wrapped around a ServerRequest pointer.
typedef Loki::SmartPtr< const FountainParseMessage >	ConstParseMsgPtr
	SmartPtr object utilizing the default SmartPtr policies wrapped around a const FountainParseMessage pointer.
typedef Loki::SmartPtr< FountainMessage >	FountainMessagePtr
	SmartPtr object utilizing the default SmartPtr policies wrapped around a FountainMessage pointer.
typedef Loki::SmartPtr< BambooLib::XMLElementList, Loki::RefCounted, Loki::DisallowConversion, Loki::RejectNullStrict >	XMLElementListPtr
	SmartPtr object wrapped around a FountainMessage pointer.
Enumerations
enum	FountainMessage::MessageAction
	enumeration that specifies the action attribute of a FountainMessage object More...

---

Detailed Description

These files, classes, and typedefs are used to build XML messages sent and received between the various Fountain components and other SSS components.

---

Typedef Documentation

XMLElementListPtr

SmartPtr object wrapped around a FountainMessage pointer. Todo: is RejectNullStrict the correct checking policy to use here? sjm 2-27-2006 This object uses the following policy classes: DestructiveCopy storage policy so this object has value semantics like a std::auto_ptr DisallowConversion conversion policy to prevent implicit conversions the pointee type RejectNullStrict checking policy to throw an exception when initialized with a NULL pointer Definition at line 61 of file FountainMessage.h.

---

Enumeration Type Documentation

enum FountainMessage::MessageAction [inherited]

enumeration that specifies the action attribute of a FountainMessage object Todo: Use UpperCamelCase naming convention here. sjm 2-27-2006 Definition at line 91 of file FountainMessage.h.

---