sipxmedialib  Version 3.3
Private Attributes | List of all members
MpToneResourceMsg Class Reference

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

#include <MpToneResourceMsg.h>

Inheritance diagram for MpToneResourceMsg:
Inheritance graph
[legend]
Collaboration diagram for MpToneResourceMsg:
Collaboration graph
[legend]

Public Member Functions

Creators
 MpToneResourceMsg (const UtlString &msgDestName, int toneCode)
 Constructor. More...
 
 MpToneResourceMsg (const MpToneResourceMsg &rMpResourceMsg)
 Copy constructor. More...
 
OsMsg * createCopy (void) const
 Create a copy of this msg object (which may be of a derived type) More...
 
 ~MpToneResourceMsg ()
 Destructor. More...
 
Manipulators
MpToneResourceMsgoperator= (const MpToneResourceMsg &rhs)
 Assignment operator. More...
 
void setToneCode (int toneCode)
 Set the tone that is associated with this resource. More...
 
Accessors
int getToneCode (void) const
 Get the tone that is associated with this resource. More...
 
- Public Member Functions inherited from MpResourceMsg
 MpResourceMsg (MpResourceMsgType msg, const UtlString &msgDestName)
 Constructor. More...
 
 MpResourceMsg (const MpResourceMsg &rMpResourceMsg)
 Copy constructor. More...
 
virtual ~MpResourceMsg ()
 Destructor. More...
 
MpResourceMsgoperator= (const MpResourceMsg &rhs)
 Assignment operator. More...
 
void setDestResourceName (const UtlString &msgDestName)
 Set the name of the resource this message applies to. More...
 
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

int mToneCode
 The tone to play/stop/etc. More...
 

Additional Inherited Members

- Public Types inherited from MpResourceMsg
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...
 

Detailed Description

Message object used to communicate with the media processing task.

Constructor & Destructor Documentation

MpToneResourceMsg ( const UtlString &  msgDestName,
int  toneCode 
)
inline

Constructor.

MpToneResourceMsg ( const MpToneResourceMsg rMpResourceMsg)
inline

Copy constructor.

~MpToneResourceMsg ( )
inline

Destructor.

Member Function Documentation

OsMsg * createCopy ( void  ) const
inlinevirtual

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

Reimplemented from MpResourceMsg.

MpToneResourceMsg & operator= ( const MpToneResourceMsg rhs)
inline

Assignment operator.

void setToneCode ( int  toneCode)
inline

Set the tone that is associated with this resource.

Set the tone that is associated with this resource.

Parameters
toneIdthe new tone that is to be set in this resource.
int getToneCode ( void  ) const
inline

Get the tone that is associated with this resource.

Returns the tone that is associated with this resource.

Member Data Documentation

int mToneCode
private

The tone to play/stop/etc.