psStopSongMessage Class Reference

This message is used by both server and client to stop a song. More...

#include <messages.h>

Public Types
enum	{ NO_SONG_ERROR = 1, ILLEGAL_SCORE, NO_INSTRUMENT }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psStopSongMessage ()
	Constructor used by the client to notice the song's interruption to the server. More...
	psStopSongMessage (uint32_t client, uint32_t songID, bool toPlayer, int8_t errorCode)
	Constructor used by the server to notice clients about stopped songs. More...
	psStopSongMessage (MsgEntry *me)
	Constructor from a MsgEntry. More...
virtual csString	ToString (NetBase::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
int8_t	errorCode
uint32_t	songID
bool	toPlayer
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

This message is used by both server and client to stop a song.

It can also be used by the server to report an error.

Definition at line 5557 of file messages.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NO_SONG_ERROR
ILLEGAL_SCORE
NO_INSTRUMENT

Definition at line 5561 of file messages.h.

Constructor & Destructor Documentation

psStopSongMessage::psStopSongMessage

(

)

Constructor used by the client to notice the song's interruption to the server.

psStopSongMessage::psStopSongMessage	(	uint32_t	client,
		uint32_t	songID,
		bool	toPlayer,
		int8_t	errorCode
	)

Constructor used by the server to notice clients about stopped songs.

Parameters

client	the client's ID that will receive the message.
songID	the song's ID to stop.
toPlayer	true if this message is directed to the player that plays the song.
errorCode	code used to comunicate failure to the client.

psStopSongMessage::psStopSongMessage

(

MsgEntry *

me

)

Constructor from a MsgEntry.

Parameters

me	the message entry.

Member Function Documentation

psStopSongMessage::PSF_DECLARE_MSG_FACTORY

(

)

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

inlinevirtual

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.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Definition at line 5593 of file messages.h.

Member Data Documentation

int8_t psStopSongMessage::errorCode

Definition at line 5600 of file messages.h.

uint32_t psStopSongMessage::songID

Definition at line 5598 of file messages.h.

bool psStopSongMessage::toPlayer

Definition at line 5599 of file messages.h.

---

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

• common/net/messages.h