OpalRFC2833 Class Reference

#include <rfc2833.h>

List of all members.

Public Member Functions
	OpalRFC2833 (const PNotifier &receiveNotifier)
virtual BOOL	SendTone (char tone, unsigned duration)
virtual BOOL	BeginTransmit (char tone)
virtual BOOL	EndTransmit ()
virtual void	OnStartReceive (char tone)
virtual void	OnEndReceive (char tone, unsigned duration, unsigned timestamp)
RTP_DataFrame::PayloadTypes	GetPayloadType () const
void	SetPayloadType (RTP_DataFrame::PayloadTypes type)
const PNotifier &	GetReceiveHandler () const
const PNotifier &	GetTransmitHandler () const
Protected Types
enum	{ TransmitIdle, TransmitActive, TransmitEnding }
Protected Member Functions
	PDECLARE_NOTIFIER (RTP_DataFrame, OpalRFC2833, ReceivedPacket)
	PDECLARE_NOTIFIER (RTP_DataFrame, OpalRFC2833, TransmitPacket)
	PDECLARE_NOTIFIER (PTimer, OpalRFC2833, ReceiveTimeout)
	PDECLARE_NOTIFIER (PTimer, OpalRFC2833, TransmitEnded)
Protected Attributes
RTP_DataFrame::PayloadTypes	payloadType
PMutex	mutex
PNotifier	receiveNotifier
BOOL	receiveComplete
BYTE	receivedTone
unsigned	receivedDuration
unsigned	receiveTimestamp
PTimer	receiveTimer
PNotifier	receiveHandler
enum OpalRFC2833:: { ... }	transmitState
BYTE	transmitCode
unsigned	transmitTimestamp
PTimer	transmitTimer
PNotifier	transmitHandler

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

TransmitIdle
TransmitActive
TransmitEnding

---

Constructor & Destructor Documentation

OpalRFC2833::OpalRFC2833

(

const PNotifier &

receiveNotifier

)

---

Member Function Documentation

virtual BOOL OpalRFC2833::BeginTransmit

(

char

tone

)

[virtual]

Parameters:

tone	DTMF tone code

virtual BOOL OpalRFC2833::EndTransmit

(

)

[virtual]

RTP_DataFrame::PayloadTypes OpalRFC2833::GetPayloadType

(

)

const [inline]

References payloadType.

const PNotifier& OpalRFC2833::GetReceiveHandler

(

)

const [inline]

References receiveHandler.

const PNotifier& OpalRFC2833::GetTransmitHandler

(

)

const [inline]

References transmitHandler.

virtual void OpalRFC2833::OnEndReceive	(	char	tone,
		unsigned	duration,
		unsigned	timestamp
	)		[virtual]

virtual void OpalRFC2833::OnStartReceive

(

char

tone

)

[virtual]

OpalRFC2833::PDECLARE_NOTIFIER	(	RTP_DataFrame	,
		OpalRFC2833	,
		ReceivedPacket
	)		[protected]

OpalRFC2833::PDECLARE_NOTIFIER	(	RTP_DataFrame	,
		OpalRFC2833	,
		TransmitPacket
	)		[protected]

OpalRFC2833::PDECLARE_NOTIFIER	(	PTimer	,
		OpalRFC2833	,
		ReceiveTimeout
	)		[protected]

OpalRFC2833::PDECLARE_NOTIFIER	(	PTimer	,
		OpalRFC2833	,
		TransmitEnded
	)		[protected]

virtual BOOL OpalRFC2833::SendTone	(	char	tone,
		unsigned	duration
	)		[virtual]

Parameters:

tone	DTMF tone code
duration	Duration of tone in milliseconds

void OpalRFC2833::SetPayloadType

(

RTP_DataFrame::PayloadTypes

type

)

[inline]

Parameters:

type	new payload type

References payloadType.

---

Member Data Documentation

PMutex OpalRFC2833::mutex [protected]

RTP_DataFrame::PayloadTypes OpalRFC2833::payloadType [protected]

Referenced by GetPayloadType(), and SetPayloadType().

BOOL OpalRFC2833::receiveComplete [protected]

unsigned OpalRFC2833::receivedDuration [protected]

BYTE OpalRFC2833::receivedTone [protected]

PNotifier OpalRFC2833::receiveHandler [protected]

Referenced by GetReceiveHandler().

PNotifier OpalRFC2833::receiveNotifier [protected]

PTimer OpalRFC2833::receiveTimer [protected]

unsigned OpalRFC2833::receiveTimestamp [protected]

BYTE OpalRFC2833::transmitCode [protected]

PNotifier OpalRFC2833::transmitHandler [protected]

Referenced by GetTransmitHandler().

enum { ... } OpalRFC2833::transmitState [protected]

PTimer OpalRFC2833::transmitTimer [protected]

unsigned OpalRFC2833::transmitTimestamp [protected]

---

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

• rfc2833.h