Coral::RTPSender Class Reference

RTP Sender. More...

#include <rtpsender.h>

Inheritance diagram for Coral::RTPSender:

List of all members.

Public Member Functions
	RTPSender ()
	RTPSender (const card32 ssrc, EncoderInterface *encoder, Socket *senderSocket, const cardinal maxPacketSize=1500, BandwidthManager *bwManager=NULL)
	~RTPSender ()
void	init (const card32 ssrc, EncoderInterface *encoder, Socket *senderSocket, const cardinal maxPacketSize=1500, BandwidthManager *bwManager=NULL)
AbstractQoSDescription *	getQoSDescription (const card64 offset)
void	updateQuality (const AbstractQoSDescription *aqd)
void	lock ()
void	unlock ()
cardinal	getMaxPacketSize () const
cardinal	setMaxPacketSize (const cardinal size)
bool	paused () const
bool	transmissionErrorDetected ()
void	setPause (const bool on)
card64	getBytesSent () const
card64	getPacketsSent () const
void	resetBytesSent ()
void	resetPacketsSent ()
Private Member Functions
void	timerEvent ()
void	update (const AbstractQoSDescription *aqd)
Private Attributes
EncoderInterface *	Encoder
Socket *	SenderSocket
cardinal	FramesPerSecond
cardinal	RenewCounter
cardinal	MaxPacketSize
card32	SSRC
card64	BytesSent
card64	PacketsSent
card64	TimeStamp
card32	PayloadBytesSent
card32	PayloadPacketsSent
bool	Pause
bool	TransmissionError
InternetFlow	Flow [RTPConstants::RTPMaxQualityLayers]
card16	SequenceNumber [RTPConstants::RTPMaxQualityLayers]
BandwidthManager *	BandwidthMgr
cardinal	Bandwidth [RTPConstants::RTPMaxQualityLayers]
double	BufferDelay [RTPConstants::RTPMaxQualityLayers]
TrafficShaper	SenderReportBuffer
TrafficShaper	Shaper [RTPConstants::RTPMaxQualityLayers]

---

Detailed Description

RTP Sender.

This class implements an RTP sender based on TimedThread.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

Coral::RTPSender::RTPSender

(

)

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

See also:

init

Coral::RTPSender::RTPSender	(	const card32	ssrc,
		EncoderInterface *	encoder,
		Socket *	senderSocket,
		const cardinal	maxPacketSize = 1500,
		BandwidthManager *	bwManager = NULL
	)

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

Parameters:

ssrc	Sender's SSRC (see RFC 1889).
encoder	Encoder to get packets to send from.
senderSocket	Socket to write packets to.
maxPacketSize	Maximum packet size.
bwManager	Bandwidth manager.

See also:

Thread::start

Coral::RTPSender::~RTPSender

(

)

Destructor.

---

Member Function Documentation

card64 Coral::RTPSender::getBytesSent

(

)

const [inline]

Get number of bytes sent.

Returns:

Bytes sent.

cardinal Coral::RTPSender::getMaxPacketSize

(

)

const [inline]

Get maximum packet size.

Returns:

Maximum packet size.

card64 Coral::RTPSender::getPacketsSent

(

)

const [inline]

Get number of packets sent.

Returns:

Packets sent.

AbstractQoSDescription * Coral::RTPSender::getQoSDescription

(

const card64

offset

)

[virtual]

Implementation of ManagedStreamInterface's getQoSDescription().

See also:

ManagedStreamInterface::getQoSDescription

Implements Coral::ManagedStreamInterface.

void Coral::RTPSender::init	(	const card32	ssrc,
		EncoderInterface *	encoder,
		Socket *	senderSocket,
		const cardinal	maxPacketSize = 1500,
		BandwidthManager *	bwManager = NULL
	)

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

Parameters:

ssrc	Sender's SSRC (see RFC 1889).
encoder	Encoder to get packets to send from.
senderSocket	Socket to write packets to.
maxPacketSize	Maximum packet size.
bwManager	Bandwidth manager.

See also:

Thread::start

void Coral::RTPSender::lock

(

)

[virtual]

Implementation of ManagedStreamInterface's lock().

See also:

ManagedStreamInterface::lock

Implements Coral::ManagedStreamInterface.

bool Coral::RTPSender::paused

(

)

const [inline]

Check, if transmission is paused.

Returns:

true, if paused; false otherwise.

void Coral::RTPSender::resetBytesSent

(

)

[inline]

Reset number of bytes sent.

void Coral::RTPSender::resetPacketsSent

(

)

[inline]

Reset number of packets sent.

cardinal Coral::RTPSender::setMaxPacketSize

(

const cardinal

size

)

[inline]

Set maximum packet size.

Parameters:

size	Maximum packet size.

Returns:

Maximum packet size set.

void Coral::RTPSender::setPause

(

const bool

on

)

[inline]

Set pause on or off.

Parameters:

on	true to set pause on; false to set pause off.

void Coral::RTPSender::timerEvent

(

)

[private, virtual]

The virtual timerEvent() method, which contains the timed thread's implementation. It has to be implemented by classes, which inherit TimedThread. This method is called regularly with the given interval.

Implements Coral::TimedThread.

bool Coral::RTPSender::transmissionErrorDetected

(

)

[inline]

Check, if transmission error has been detected (e.g. destination rejects packets, no route etc.). Note: The transmission error attribute will be resetted to false by calling this method.

void Coral::RTPSender::unlock

(

)

[virtual]

Implementation of ManagedStreamInterface's unlock().

See also:

ManagedStreamInterface::unlock

Implements Coral::ManagedStreamInterface.

void Coral::RTPSender::update

(

const AbstractQoSDescription *

aqd

)

[private]

void Coral::RTPSender::updateQuality

(

const AbstractQoSDescription *

aqd

)

[virtual]

Implementation of ManagedStreamInterface's updateQuality().

See also:

ManagedStreamInterface::updateQuality

Implements Coral::ManagedStreamInterface.

---

Member Data Documentation

cardinal Coral::RTPSender::Bandwidth[RTPConstants::RTPMaxQualityLayers] [private]

BandwidthManager* Coral::RTPSender::BandwidthMgr [private]

double Coral::RTPSender::BufferDelay[RTPConstants::RTPMaxQualityLayers] [private]

card64 Coral::RTPSender::BytesSent [private]

EncoderInterface* Coral::RTPSender::Encoder [private]

InternetFlow Coral::RTPSender::Flow[RTPConstants::RTPMaxQualityLayers] [private]

cardinal Coral::RTPSender::FramesPerSecond [private]

cardinal Coral::RTPSender::MaxPacketSize [private]

card64 Coral::RTPSender::PacketsSent [private]

bool Coral::RTPSender::Pause [private]

card32 Coral::RTPSender::PayloadBytesSent [private]

card32 Coral::RTPSender::PayloadPacketsSent [private]

cardinal Coral::RTPSender::RenewCounter [private]

TrafficShaper Coral::RTPSender::SenderReportBuffer [private]

Socket* Coral::RTPSender::SenderSocket [private]

card16 Coral::RTPSender::SequenceNumber[RTPConstants::RTPMaxQualityLayers] [private]

TrafficShaper Coral::RTPSender::Shaper[RTPConstants::RTPMaxQualityLayers] [private]

card32 Coral::RTPSender::SSRC [private]

card64 Coral::RTPSender::TimeStamp [private]

bool Coral::RTPSender::TransmissionError [private]

---

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

• rtpsender.h
• rtpsender.cc