psPetitionRequestMessage Class Reference

Messages sent by the user to the server with requests for petition information. More...

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psPetitionRequestMessage (bool gm, const char *requestCmd, int petitionID=-1, const char *petDesc="")
	psPetitionRequestMessage (MsgEntry *message)
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string. More...
Public Member Functions inherited from psMessageCracker
void	FireEvent ()
	Publishes the message to the local program. More...
virtual csString	GetMessageTypeName () const =0
	Gets the name of the message type. More...
void	Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
	Multicasts the message to all current connections. More...
	psMessageCracker ()
void	SendMessage ()
	Sends the message to the client/server. More...
virtual	~psMessageCracker ()

Public Attributes
csString	desc
int	id
bool	isGM
csString	request
Public Attributes inherited from psMessageCracker
int	filterNumber
csRef< MsgEntry >	msg
bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

Messages sent by the user to the server with requests for petition information.

This class was added in case we need to add more petition requests to the server, currently the recognized requests are:

• query : return list of user petitions or all petitions if GM
• cancel : cancel the specified petition
• change : change the specified petition
• close : closes the specified petition
• assign : assign the GM to work on the specified petition
• escalate : escalates the specified petition

Definition at line 1045 of file messages.h.

Constructor & Destructor Documentation

psPetitionRequestMessage::psPetitionRequestMessage	(	bool	gm,
		const char *	requestCmd,
		int	petitionID = -1,
		const char *	petDesc = ""
	)

psPetitionRequestMessage::psPetitionRequestMessage

(

MsgEntry *

message

)

Member Function Documentation

psPetitionRequestMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psPetitionRequestMessage::ToString ( NetBase::AccessPointers *  accessPointers )

virtual

Converts the message into human readable string.

Parameters

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

csString psPetitionRequestMessage::desc

Definition at line 1050 of file messages.h.

int psPetitionRequestMessage::id

Definition at line 1051 of file messages.h.

bool psPetitionRequestMessage::isGM

Definition at line 1048 of file messages.h.

csString psPetitionRequestMessage::request

Definition at line 1049 of file messages.h.

---

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

• common/net/messages.h