#include <rfc4103.h>

Inheritance diagram for OpalT140MediaStream:

Collaboration diagram for OpalT140MediaStream:

Public Member Functions
	OpalT140MediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

virtual PBoolean	IsSynchronous () const

virtual PBoolean	RequiresPatchThread () const

bool	ReadPacket (RTP_DataFrame &packet)

bool	WritePacket (RTP_DataFrame &packet)

Public Member Functions inherited from OpalMediaStream
virtual PString	GetPatchThreadName () const

virtual bool	InternalUpdateMediaFormat (const OpalMediaFormat &mediaFormat)

virtual bool	InternalSetPaused (bool pause, bool fromUser, bool fromPatch)

virtual bool	InternalExecuteCommand (const OpalMediaCommand &command)

void	PrintOn (ostream &strm) const

virtual OpalMediaFormat	GetMediaFormat () const

virtual bool	SetMediaFormat (const OpalMediaFormat &mediaFormat)

bool	UpdateMediaFormat (const OpalMediaFormat &mediaFormat, bool mergeOnly=false)

bool	ExecuteCommand (const OpalMediaCommand &command) const

virtual PBoolean	Open ()

virtual bool	IsOpen () const

virtual bool	IsEstablished () const

virtual PBoolean	Start ()

virtual PBoolean	Close ()

virtual void	OnStartMediaPatch ()

virtual void	OnStopMediaPatch (OpalMediaPatch &patch)

virtual bool	SetMediaPassThrough (OpalMediaStream &otherStream, bool bypass)

virtual PBoolean	WritePackets (RTP_DataFrameList &packets)

virtual PBoolean	ReadData (BYTE *data, PINDEX size, PINDEX &length)

virtual PBoolean	WriteData (const BYTE *data, PINDEX length, PINDEX &written)

virtual bool	PushPacket (RTP_DataFrame &packet)

virtual PBoolean	SetDataSize (PINDEX dataSize, PINDEX frameTime)

PINDEX	GetDataSize () const

virtual PBoolean	RequiresPatchThread (OpalMediaStream *stream) const

virtual bool	RequireMediaTransportThread (OpalMediaStream &stream) const

virtual bool	EnableJitterBuffer (bool enab=true)

OpalConnection &	GetConnection () const

bool	IsSource () const

bool	IsSink () const

unsigned	GetSessionID () const

void	SetSessionID (unsigned id)

PString	GetID () const

unsigned	GetTimestamp () const

void	SetTimestamp (unsigned ts)

bool	GetMarker () const

void	SetMarker (bool m)

bool	IsPaused () const

bool	SetPaused (bool pause)

virtual PBoolean	SetPatch (OpalMediaPatch *patch)

OpalMediaPatchPtr	GetPatch () const

void	AddFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const

bool	RemoveFilter (const PNotifier &filter, const OpalMediaFormat &stage=OpalMediaFormat()) const

virtual void	GetStatistics (OpalMediaStatistics &statistics, bool fromPatch=false) const

	P_DECLARE_BITWISE_ENUM (Details, 6,(DetailMinimum, DetailEOL, DetailNAT, DetailSecured, DetailFEC, DetailAudio, DetailAddresses))

virtual void	PrintDetail (ostream &strm, const char *prefix=NULL, Details details=Details::All()) const

	~OpalMediaStream ()

Protected Member Functions
virtual void	InternalClose ()

Protected Member Functions inherited from OpalMediaStream
OpalMediaPatchPtr	InternalSetPatchPart1 (OpalMediaPatch *newPatch)

void	InternalSetPatchPart2 (const OpalMediaPatchPtr &oldPatch)

virtual bool	InternalSetJitterBuffer (const OpalJitterBuffer::Init &init)

	OpalMediaStream (OpalConnection &conn, const OpalMediaFormat &mediaFormat, unsigned sessionID, bool isSource)

Additional Inherited Members
Protected Types inherited from OpalMediaStream
typedef OpalMediaPatchPtr	PatchPtr

Protected Attributes inherited from OpalMediaStream
OpalConnection &	m_connection

unsigned	m_sessionID

WORD	m_sequenceNumber

RTP_SyncSourceId	m_syncSourceId

PString	m_identifier

OpalMediaFormat	m_mediaFormat

atomic< bool >	m_paused

bool	m_isSource

atomic< bool >	m_isOpen

PINDEX	m_defaultDataSize

unsigned	m_timestamp

bool	m_marker

OpalMediaPatchPtr	m_mediaPatch

RTP_DataFrame::PayloadTypes	m_payloadType

unsigned	m_frameTime

PINDEX	m_frameSize

Detailed Description

Media stream for carrying RFC 4103 (T.140) instant message over RTP

Constructor & Destructor Documentation

OpalT140MediaStream::OpalT140MediaStream	(	OpalConnection &	conn,
		const OpalMediaFormat &	mediaFormat,
		unsigned	sessionID,
		bool	isSource
	)

Parameters

mediaFormat	Media format for stream
sessionID	Session number for stream
isSource	Is a source stream

Member Function Documentation

virtual void OpalT140MediaStream::InternalClose ( )

inlineprotectedvirtual

Close any internal components of the stream. This should be used in preference to overriding the Close() function as it is guaranteed to be called exactly once and avoids race conditions in the shut down sequence of a media stream.

Implements OpalMediaStream.

virtual PBoolean OpalT140MediaStream::IsSynchronous ( ) const

inlinevirtual

Indicate if the media stream is synchronous. If this returns true then the media stream will block of the amount of time it takes to annunciate the data. For example if the media stream is over a sound card, and 480 bytes of data are to be written it will take 30 milliseconds to complete.

Implements OpalMediaStream.

bool OpalT140MediaStream::ReadPacket ( RTP_DataFrame & packet )

virtual

Read an RTP frame of data from the source media stream. The default behaviour simply calls ReadData() on the data portion of the RTP_DataFrame and sets the frames timestamp and marker from the internal member variables of the media stream class.

Reimplemented from OpalMediaStream.

virtual PBoolean OpalT140MediaStream::RequiresPatchThread ( ) const

inlinevirtual

Reimplemented from OpalMediaStream.

bool OpalT140MediaStream::WritePacket ( RTP_DataFrame & packet )

virtual

Write an RTP frame of data to the sink media stream. The default behaviour simply calls WriteData() on the data portion of the RTP_DataFrame and and sets the internal timestamp and marker from the member variables of the media stream class.

Reimplemented from OpalMediaStream.

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

rfc4103.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation