MpResourceMsg Class Reference

Message object used to communicate with the media processing task. More...

#include <MpResourceMsg.h>

Inheritance diagram for MpResourceMsg:

Collaboration diagram for MpResourceMsg:

Public Types
enum	MpResourceMsgType {   MPRM_RESOURCE_ENABLE, MPRM_RESOURCE_DISABLE, MPRM_ENABLE_ALL_NOTIFICATIONS, MPRM_DISABLE_ALL_NOTIFICATIONS,   MPRM_START_TONE, MPRM_STOP_TONE, MPRM_BRIDGE_SET_GAINS, MPRM_DECODE_SELECT_CODECS,   MPRM_SET_SOCKETS, MPRM_RESET_SOCKETS, MPRM_EXTERNAL_MESSAGE_START = 128 }
	Resource message types. More...

Public Member Functions
Creators
	MpResourceMsg (MpResourceMsgType msg, const UtlString &msgDestName)
	Constructor. More...
	MpResourceMsg (const MpResourceMsg &rMpResourceMsg)
	Copy constructor. More...
virtual OsMsg *	createCopy () const
	Create a copy of this msg object (which may be of a derived type) More...
virtual	~MpResourceMsg ()
	Destructor. More...
Manipulators
MpResourceMsg &	operator= (const MpResourceMsg &rhs)
	Assignment operator. More...
void	setDestResourceName (const UtlString &msgDestName)
	Set the name of the resource this message applies to. More...
Accessors
int	getMsg () const
	Returns the type of the media resource message. More...
UtlString	getDestResourceName () const
	Get the name of the resource this message applies to. More...

Private Attributes
UtlString	mMsgDestName
	Intended recipient for this message. More...

Detailed Description

Message object used to communicate with the media processing task.

Member Enumeration Documentation

enum MpResourceMsgType

Resource message types.

Enumerator
MPRM_RESOURCE_ENABLE	All resources: Enable resource.
MPRM_RESOURCE_DISABLE	All resources: Disable resource.
MPRM_ENABLE_ALL_NOTIFICATIONS	All resources: Enable all notifications to be sent from a resource.
MPRM_DISABLE_ALL_NOTIFICATIONS	All resources: Disable all notification from being sent a from resource.
MPRM_START_TONE	MprToneGen: Start a tone.
MPRM_STOP_TONE	MprToneGen: Stop a tone.
MPRM_BRIDGE_SET_GAINS	MprBridge: Set row or column in mix matrix.
MPRM_DECODE_SELECT_CODECS	MprDecode/MprEncode: Select codecs.
MPRM_SET_SOCKETS	MprFromNet and containers set RTP/RTCP sockets.
MPRM_RESET_SOCKETS	MprFromNet and containers stop reading sockets.
MPRM_EXTERNAL_MESSAGE_START

Constructor & Destructor Documentation

MpResourceMsg	(	MpResourceMsgType	msg,
		const UtlString &	msgDestName
	)

Constructor.

MpResourceMsg

(

const MpResourceMsg &

rMpResourceMsg

)

Copy constructor.

~MpResourceMsg ( )

virtual

Destructor.

Member Function Documentation

OsMsg * createCopy ( void  ) const

virtual

Create a copy of this msg object (which may be of a derived type)

Reimplemented in MprRtpStartReceiveMsg, MprDecodeSelectCodecsMsg, MprBridgeSetGainsMsg, MpIntResourceMsg, MpSetSocketsMsg, MpStringResourceMsg, MpPackedResourceMsg, and MpToneResourceMsg.

MpResourceMsg & operator=

(

const MpResourceMsg &

rhs

)

Assignment operator.

void setDestResourceName

(

const UtlString &

msgDestName

)

Set the name of the resource this message applies to.

Sets the name of the intended recipient for this message.

int getMsg

(

void

)

const

Returns the type of the media resource message.

UtlString getDestResourceName

(

void

)

const

Get the name of the resource this message applies to.

Returns the name of the MpResource object that is the intended recipient for this message.

Member Data Documentation

UtlString mMsgDestName

private

Intended recipient for this message.