NodeRequest Class Reference
[Fountain master and slave nodes, Message Building and Parsing]

Used for request messages sent from a Fountain node. More...

#include <NodeMessage.h>

Inheritance diagram for NodeRequest:

List of all members.

Static Public Member Functions
static NodeRequestPtr	buildJoin (const NodeID &src, const NodeID &dest, const std::string &versionNumberString)
	Create a join request message.
static NodeRequestPtr	buildPulse (const NodeID &src, const NodeID &dest)
	Create a pulse request message.
static NodeRequestPtr	buildTrace (const NodeID &src, const NodeID &dest)
	Create a trace request message.
static NodeRequestPtr	buildPingPong (const NodeID &src, const NodeID &dest, unsigned int numPingPongs)
	Create a pingPong request message.
static NodeRequestPtr	buildLostParent (const NodeID &src, const NodeID &dest, const NodeID &parentID, const char *message)
	Create a lostParent request message.
static NodeRequestPtr	buildLostChild (const NodeID &src, const NodeID &dest, const NodeID &childID)
	Create a lostChild request message.
static NodeRequestPtr	buildNewParent (const NodeID &src, const NodeID &dest, const NodeID &newParentID)
	Create a newParent request message.
static NodeRequestPtr	buildSync (const NodeID &src, const NodeID &dest)
	Create a sync request message.
static NodeRequestPtr	buildWakeup (const NodeID &src, const NodeID &dest)
	Create a wakeup request message.
Protected Member Functions
	NodeRequest (MessageAction a, const NodeID &src, const NodeID &dest)
	Default constructor.
Static Protected Member Functions
static NodeRequestPtr	create (MessageAction a, const NodeID &src, const NodeID &dest)
	Create a NodeRequest.

---

Detailed Description

Used for request messages sent from a Fountain node.

---

Constructor & Destructor Documentation

NodeRequest::NodeRequest (  MessageAction  a, const NodeID &  src, const NodeID &  dest )  [inline, protected]

Default constructor. Parameters: a  The MessageAction enum for this message src  The NodeID of the Fountain node creating this message dest  The NodeID of the Fountain node this message is destined to

---

Member Function Documentation

NodeRequestPtr NodeRequest::buildJoin (  const NodeID &  src, const NodeID &  dest, const std::string &  versionNumberString )  [static]

Create a join request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message versionNumberString  The version number of a Fountain Node Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildLostChild (  const NodeID &  src, const NodeID &  dest, const NodeID &  childID )  [static]

Create a lostChild request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message [in]  childID  The NodeID of the lost child node Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildLostParent (  const NodeID &  src, const NodeID &  dest, const NodeID &  parentID, const char *  message )  [static]

Create a lostParent request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message [in]  parentID  The NodeID of the lost parent node [in]  message  A descriptive message about why the parent node was lost Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildNewParent (  const NodeID &  src, const NodeID &  dest, const NodeID &  newParentID )  [static]

Create a newParent request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message [in]  newParentID  The NodeID of the new parent Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildPingPong (  const NodeID &  src, const NodeID &  dest, unsigned int  numPingPongs )  [static]

Create a pingPong request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message [in]  numPingPongs  The number of ping pong requests to send Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildPulse (  const NodeID &  src, const NodeID &  dest )  [static]

Create a pulse request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildSync (  const NodeID &  src, const NodeID &  dest )  [static]

Create a sync request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildTrace (  const NodeID &  src, const NodeID &  dest )  [static]

Create a trace request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::buildWakeup (  const NodeID &  src, const NodeID &  dest )  [static]

Create a wakeup request message. Parameters: [in]  src  The origin of this message [in]  dest  The destination of this message Return values: NodeRequestPtr  A pointer to the request message

NodeRequestPtr NodeRequest::create (  MessageAction  a, const NodeID &  src, const NodeID &  dest )  [static, protected]

Create a NodeRequest. Parameters: [in]  a  The MessageAction [in]  src  The origin of this message [in]  dest  The destination of this message Return values: NodeRequestPtr  A pointer to the NodeRequest object

---

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

• /afs/scl.ameslab.gov/user/samm/fountain/source/nodes/NodeMessage.h
• /afs/scl.ameslab.gov/user/samm/fountain/source/nodes/NodeMessage.cpp

---