ServerResponse Class Reference
[Fountain serverMessage Building and Parsing]

Used for response messages sent from the Fountain server. More...

#include <ServerMessage.h>

Inheritance diagram for ServerResponse:

ServerMessage FountainMessage BambooLib::BuildMsg List of all members.

Static Public Member Functions

static ServerResponsePtr buildError (MessageAction action, FountainErrorCode code, const std::string &errorMessage)
 Create an error ServerResponse.
static ServerResponsePtr buildAdmin ()
 Build an admin response message.
static ServerResponsePtr buildQuery ()
 Build a query response message.

Protected Member Functions

 ServerResponse (MessageAction a)
 Default constructor.

Detailed Description

Used for response messages sent from the Fountain server.


Constructor & Destructor Documentation

ServerResponse::ServerResponse MessageAction  a  )  [inline, protected]
 

Default constructor.

Parameters:
[in] a The message action


Member Function Documentation

ServerResponsePtr ServerResponse::buildAdmin  )  [static]
 

Build an admin response message.

Return values:
ServerResponsePtr A pointer to the ServerResponse object

ServerResponsePtr ServerResponse::buildError MessageAction  action,
FountainErrorCode  code,
const std::string &  errorMessage
[static]
 

Create an error ServerResponse.

Parameters:
[in] action The MessageAction
[in] code The FountainErrorCode to use for the status element
[in] errorMessage The message to use for the status element
Return values:
ServerResponsePtr A pointer to the ServerResponse object

ServerResponsePtr ServerResponse::buildQuery  )  [static]
 

Build a query response message.

Return values:
ServerResponsePtr A pointer to the ServerResponse object


The documentation for this class was generated from the following files:
Generated on Wed Mar 8 14:43:33 2006 for Fountain by  doxygen 1.4.6