#include <messages.h>

Public Types
enum	{ REQUEST, RESPONSE, SAVE, SAVERESPONSE }
Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psWriteBookMessage (int slotID, int containerID, csString &title, csString &content)
	'Request to Save' message, from client to server
	psWriteBookMessage (uint32_t clientNum, csString &title, csString &content, bool success, int slotID, int containerID)
	Response from server, if success is false then content is the error message.
	psWriteBookMessage (MsgEntry *me)
	psWriteBookMessage (uint32_t clientNum, csString &title, bool success)
	Response to Save from server to client.
	psWriteBookMessage (int slotID, int containerID)
	'Request to Write' message, from client to server.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
int	containerID
csString	content
uint8_t	messagetype
int	slotID
bool	success
csString	title

Detailed Description

Definition at line 4499 of file messages.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

REQUEST
RESPONSE
SAVE
SAVERESPONSE

Definition at line 4532 of file messages.h.

Constructor & Destructor Documentation

psWriteBookMessage::psWriteBookMessage	(	int	slotID,
		int	containerID
	)

'Request to Write' message, from client to server.

psWriteBookMessage::psWriteBookMessage	(	int	slotID,
		int	containerID,
		csString &	title,
		csString &	content
	)

'Request to Save' message, from client to server

psWriteBookMessage::psWriteBookMessage	(	uint32_t	clientNum,
		csString &	title,
		csString &	content,
		bool	success,
		int	slotID,
		int	containerID
	)

Response from server, if success is false then content is the error message.

psWriteBookMessage::psWriteBookMessage	(	uint32_t	clientNum,
		csString &	title,
		bool	success
	)

Response to Save from server to client.

psWriteBookMessage::psWriteBookMessage ( MsgEntry * me )

Member Function Documentation

psWriteBookMessage::PSF_DECLARE_MSG_FACTORY ( )

virtual csString psWriteBookMessage::ToString ( NetBase::AccessPointers * accessPointers ) [virtual]

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters:

accessPointers A struct to a number of access pointers.