MprnProgressMsg Class Reference

#include <MprnProgressMsg.h>

Inheritance diagram for MprnProgressMsg:

Collaboration diagram for MprnProgressMsg:

Public Member Functions
Creators
	MprnProgressMsg (MpResNotificationMsg::RNMsgType msgType, const UtlString &namedResOriginator, unsigned posMS, unsigned totalMS)
	Constructor. More...
	MprnProgressMsg (const MprnProgressMsg &rMsg)
	Copy constructor. More...
virtual OsMsg *	createCopy (void) const
	Create a copy of this msg object (which may be of a derived type) More...
virtual	~MprnProgressMsg ()
	Destructor. More...
Manipulators
MprnProgressMsg &	operator= (const MprnProgressMsg &rhs)
	Assignment operator. More...
void	setPositionMS (unsigned posMS)
	Set the position in milliseconds this message reports. More...
void	setTotalMS (unsigned totalMS)
	Set the total size of the buffer in milliseconds this message reports. More...
Accessors
unsigned	getPositionMS (void) const
	Get the current reported position of this progress update in MS. More...
unsigned	getTotalMS (void) const
	Get the total size of the buffer in milliseconds this message reports. More...
Public Member Functions inherited from MpResNotificationMsg
	MpResNotificationMsg (RNMsgType msgType, const UtlString &namedResOriginator, MpConnectionID connId=MP_INVALID_CONNECTION_ID, int streamId=-1)
	Constructor. More...
	MpResNotificationMsg (const MpResNotificationMsg &rMpResNotifyMsg)
	Copy constructor. More...
virtual	~MpResNotificationMsg ()
	Destructor. More...
MpResNotificationMsg &	operator= (const MpResNotificationMsg &rhs)
	Assignment operator. More...
void	setOriginatingResourceName (const UtlString &resOriginator)
	Set the name of the resource this message applies to. More...
void	setConnectionId (MpConnectionID connId)
	Set the connection ID that this notification is associated with. More...
void	setStreamId (int streamId)
	Set the stream number inside the connection this notification is associated with. More...
int	getMsg () const
	Returns the type of the media resource notification message. More...
UtlString	getOriginatingResourceName () const
	Get the name of the resource that originated this message. More...
MpConnectionID	getConnectionId () const
	Get the connection ID that this message is associated with. More...
int	getStreamId () const
	Get the stream number inside the connection this notification is associated with. More...

Private Attributes
unsigned	mCurPositionMS
	current position reported, in milliseconds. More...
unsigned	mTotalMS
	Total size in milliseconds. More...

Additional Inherited Members
Public Types inherited from MpResNotificationMsg
enum	RNMsgType {   MPRNM_MESSAGE_INVALID, MPRNM_MESSAGE_ALL = MPRNM_MESSAGE_INVALID, MPRNM_FROMFILE_STARTED, MPRNM_FROMFILE_PAUSED,   MPRNM_FROMFILE_RESUMED, MPRNM_FROMFILE_STOPPED, MPRNM_FROMFILE_FINISHED, MPRNM_FROMFILE_ERROR,   MPRNM_FROMFILE_PROGRESS, MPRNM_RECORDER_STARTED, MPRNM_RECORDER_PAUSED, MPRNM_RECORDER_RESUMED,   MPRNM_RECORDER_STOPPED, MPRNM_RECORDER_FINISHED, MPRNM_RECORDER_ERROR, MPRNM_DTMF_RECEIVED,   MPRNM_DELAY_SPEECH_STARTED, MPRNM_DELAY_NO_DELAY, MPRNM_DELAY_QUIESCENCE, MPRNM_RX_STREAM_ACTIVITY,   MPRNM_ENERGY_LEVEL, MPRNM_VOICE_STARTED, MPRNM_VOICE_STOPPED, MPRNM_H264_SPS,   MPRNM_H264_PPS, MPRNM_TONE_DETECT_ON, MPRNM_TONE_DETECT_OFF, MPRNM_RECORDER_CIRCULARBUFFER_WATERMARK_REACHED,   MPRNM_INPUT_DEVICE_NOT_PRESENT, MPRNM_OUTPUT_DEVICE_NOT_PRESENT, MPRNM_INPUT_DEVICE_NOW_PRESENT, MPRNM_OUTPUT_DEVICE_NOW_PRESENT }
	Phone set message types. More...

Detailed Description

Message notification object used to communicate millisecond-based progress updates from resources outward towards the flowgraph, and up through to users above mediaLib and beyond.

Constructor & Destructor Documentation

MprnProgressMsg	(	MpResNotificationMsg::RNMsgType	msgType,
		const UtlString &	namedResOriginator,
		unsigned	posMS,
		unsigned	totalMS
	)

Constructor.

MprnProgressMsg

(

const MprnProgressMsg &

rMsg

)

Copy constructor.

~MprnProgressMsg ( )

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 from MpResNotificationMsg.

MprnProgressMsg & operator=

(

const MprnProgressMsg &

rhs

)

Assignment operator.

void setPositionMS

(

unsigned

posMS

)

Set the position in milliseconds this message reports.

void setTotalMS

(

unsigned

totalMS

)

Set the total size of the buffer in milliseconds this message reports.

unsigned getPositionMS

(

void

)

const

Get the current reported position of this progress update in MS.

unsigned getTotalMS

(

void

)

const

Get the total size of the buffer in milliseconds this message reports.

Member Data Documentation

unsigned mCurPositionMS

private

current position reported, in milliseconds.

unsigned mTotalMS

private

Total size in milliseconds.