Coral::RTPReceiver Class Reference

RTP Receiver. More...

#include <rtpreceiver.h>

Inheritance diagram for Coral::RTPReceiver:

List of all members.

Public Member Functions
	RTPReceiver ()
	RTPReceiver (DecoderInterface *decoder, Socket *receiverSocket)
	~RTPReceiver ()
void	init (DecoderInterface *decoder, Socket *receiverSocket)
card64	getPosition () const
card64	getMaxPosition () const
card64	getBytesReceived (const cardinal layer) const
card64	getPacketsReceived (const cardinal layer) const
void	resetBytesReceived (const cardinal layer)
void	resetPacketsReceived (const cardinal layer)
cardinal	getLayers () const
InternetFlow	getInternetFlow (const cardinal layer=0) const
SourceStateInfo	getSSI (const cardinal layer=0) const
Protected Attributes
cardinal	Layers
InternetFlow	Flow [RTPConstants::RTPMaxQualityLayers]
SourceStateInfo	SSI [RTPConstants::RTPMaxQualityLayers]
card64	BytesReceived [RTPConstants::RTPMaxQualityLayers]
card64	PacketsReceived [RTPConstants::RTPMaxQualityLayers]
Private Member Functions
void	run ()
Private Attributes
DecoderInterface *	Decoder
Socket *	ReceiverSocket
Friends
class	RTCPSender

---

Detailed Description

RTP Receiver.

This class implements an RTP receiver based on Thread.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

Coral::RTPReceiver::RTPReceiver

(

)

Default constructor. You have to initialize RTPReceiver by calling init(...) later!

See also:

init

Coral::RTPReceiver::RTPReceiver	(	DecoderInterface *	decoder,
		Socket *	receiverSocket
	)

Constructor for new RTPSender. The new sender's thread has to be started by calling start()!

Parameters:

decoder	Decoder to handle packets received.
receiverSocket	Socket to receive data from.

See also:

Thread::start

Coral::RTPReceiver::~RTPReceiver

(

)

Destructor.

---

Member Function Documentation

card64 Coral::RTPReceiver::getBytesReceived

(

const cardinal

layer

)

const [inline]

Get number of bytes received.

Parameters:

layer

Layer number or (cardinal)-1 to get sum of all layers.

Returns:

Bytes received.

InternetFlow Coral::RTPReceiver::getInternetFlow

(

const cardinal

layer = 0

)

const [inline]

Get InternetFlow of last transmission in a given layer.

Parameters:

layer

Layer number.

Returns:

InternetFlow.

cardinal Coral::RTPReceiver::getLayers

(

)

const [inline]

Get number of layers of last transmission.

Returns:

Number of layers.

card64 Coral::RTPReceiver::getMaxPosition

(

)

const [inline]

Get maximum position of the encoder. The access is synchronized with the receiver thread.

Returns:

Maximum position in nanoseconds.

card64 Coral::RTPReceiver::getPacketsReceived

(

const cardinal

layer

)

const [inline]

Get number of packets received.

Parameters:

layer

Layer number or (cardinal)-1 to get sum of all layers.

Returns:

Packets received.

card64 Coral::RTPReceiver::getPosition

(

)

const [inline]

Get position of the encoder. The access is synchronized with the receiver thread.

Returns:

Position in nanoseconds.

SourceStateInfo Coral::RTPReceiver::getSSI

(

const cardinal

layer = 0

)

const [inline]

Get SourceStateInfo for given layer.

void Coral::RTPReceiver::init	(	DecoderInterface *	decoder,
		Socket *	receiverSocket
	)

Initialize RTPSender. The new receiver's thread has to be started by calling start()!

Parameters:

decoder	Decoder to handle packets received.
receiverSocket	Socket to receive data from.

See also:

Thread::start

void Coral::RTPReceiver::resetBytesReceived

(

const cardinal

layer

)

[inline]

Reset number of bytes received.

Parameters:

layer

Layer number.

void Coral::RTPReceiver::resetPacketsReceived

(

const cardinal

layer

)

[inline]

Reset number of packets received.

Parameters:

layer

Layer number.

void Coral::RTPReceiver::run

(

)

[private, virtual]

The virtual run() method, which contains the thread's implementation. It has to be implemented by classes, which inherit Thread.

Implements Coral::Thread.

---

Friends And Related Function Documentation

friend class RTCPSender [friend]

RTCPSender is a friend class to enable efficient update of SSI data.

---

Member Data Documentation

card64 Coral::RTPReceiver::BytesReceived[RTPConstants::RTPMaxQualityLayers] [protected]

DecoderInterface* Coral::RTPReceiver::Decoder [private]

InternetFlow Coral::RTPReceiver::Flow[RTPConstants::RTPMaxQualityLayers] [protected]

cardinal Coral::RTPReceiver::Layers [protected]

card64 Coral::RTPReceiver::PacketsReceived[RTPConstants::RTPMaxQualityLayers] [protected]

Socket* Coral::RTPReceiver::ReceiverSocket [private]

SourceStateInfo Coral::RTPReceiver::SSI[RTPConstants::RTPMaxQualityLayers] [protected]

---

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

• rtpreceiver.h
• rtpreceiver.cc