Coral::TraceClient Class Reference

Trace Client. More...

#include <traceclient.h>

List of all members.

Public Member Functions
	TraceClient (const char *receiverName)
	~TraceClient ()
bool	play (const char *server, const char *mediaName, const card32 sessionDescriptor=0)
void	change (const char *mediaName)
void	stop ()
card64	getPosition ()
card64	getMaxPosition () const
MediaInfo	getMediaInfo () const
card8	getErrorCode () const
const char *	getEncoding () const
card64	getMinWantedBandwidth () const
card64	getMaxWantedBandwidth () const
double	getMaxTransferDelay () const
double	getWantedUtilization () const
int8	getStreamPriority () const
int8	getSessionPriority () const
Range< card64 >	getBandwidth () const
double	getFrameRate () const
double	getUtilization () const
card32	getFlags () const
cardinal	getLayers () const
card8	getIPVersion () const
bool	playing () const
String	getServerAddressString (InternetAddress::PrintFormat format=InternetAddress::PF_Address) const
String	getOurAddressString (InternetAddress::PrintFormat format=InternetAddress::PF_Address) const
card64	getBytesReceived (const cardinal layer=0) const
card64	getPacketsReceived (const cardinal layer=0) const
InternetFlow	getInternetFlow (const cardinal layer=0) const
card32	getFlowLabel (const cardinal layer=0) const
card8	getTrafficClass (const cardinal layer=0) const
card32	getServerSSRC (const cardinal layer=0) const
card32	getOurSSRC () const
card64	getPacketsLost (const cardinal layer=0) const
double	getFractionLost (const cardinal layer=0) const
double	getJitter (const cardinal layer=0) const
const char *	getEncodingName (const cardinal index)
void	setPosition (const card64 position)
void	setPause (const bool on)
void	setWantedUtilization (const double utilization)
void	setFlags (const card32 priority)
void	setMinWantedBandwidth (const card64 bandwidth)
void	setMaxWantedBandwidth (const card64 bandwidth)
void	setMaxTransferDelay (const double delay)
void	setStreamPriority (const int8 priority)
void	setSessionPriority (const int8 priority)
void	setEncoding (const cardinal index)
Private Member Functions
void	sendCommand (const bool updateRestartPosition=true)
Private Attributes
RTPReceiver *	Receiver
RTCPSender *	Sender
Socket	SenderSocket
Socket	ReceiverSocket
InternetFlow	Flow
InternetAddress	ServerAddress
InternetAddress	OurAddress
card32	OurSSRC
InternetAddress	ReceiverAddress
multimap< const cardinal, TraceDecoderInterface * >	DecoderSet
TraceDecoderRepository	Decoders
TraceClientAppPacket	Status
card64	OldPosition
card64	ChangeTimeStamp
bool	IsPlaying
Static Private Attributes
static const card64	RestartPositionUpdateDelay = 5000000

---

Detailed Description

Trace Client.

This class is a trace client.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

Coral::TraceClient::TraceClient

(

const char *

receiverName

)

Constructor for a new trace client.

Parameters:

receiverName

String with the receiver name or NULL for default.

Coral::TraceClient::~TraceClient

(

)

Destructor.

---

Member Function Documentation

void Coral::TraceClient::change

(

const char *

mediaName

)

Change media of an established connection.

Parameters:

mediaName

New media name (e.g. ../TraceFiles/Test2.list)

See also:

play

Range<card64> Coral::TraceClient::getBandwidth

(

)

const [inline]

Get bandwidth range of last transmission.

Returns:

Bandwidth range.

card64 Coral::TraceClient::getBytesReceived

(

const cardinal

layer = 0

)

const [inline]

Get number of bytes received.

Parameters:

layer

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

Returns:

Number of bytes received

const char* Coral::TraceClient::getEncoding

(

)

const [inline]

Get encoding name.

Returns:

Encoding name.

const char * Coral::TraceClient::getEncodingName

(

const cardinal

index

)

Get encoding name for a given index of the client's decoder repository.

Parameters:

index

Repository index.

Returns:

Encoding name or NULL, if index is too high.

card8 Coral::TraceClient::getErrorCode

(

)

const [inline]

Get error code.

Returns:

Error code.

card32 Coral::TraceClient::getFlags

(

)

const [inline]

Get flags of last transmission.

Returns:

Flags.

card32 Coral::TraceClient::getFlowLabel

(

const cardinal

layer = 0

)

const [inline]

Get flow label of last received packet in given layer.

Parameters:

layer

Layer number.

Returns:

Flow label.

See also:

getLayers

double Coral::TraceClient::getFractionLost

(

const cardinal

layer = 0

)

const

Get fraction of packets lost for given layer.

Parameters:

layer

Layer number.

Returns:

Fraction of packets lost.

See also:

getLayers

double Coral::TraceClient::getFrameRate

(

)

const [inline]

Get frame rate of last transmission.

Returns:

Frame rate.

InternetFlow Coral::TraceClient::getInternetFlow

(

const cardinal

layer = 0

)

const [inline]

Get InternetFlow of last received packet in given layer.

Parameters:

layer

Layer number.

Returns:

InternetFlow.

See also:

getLayers

card8 Coral::TraceClient::getIPVersion

(

)

const

Get IP version.

Returns:

IP Version.

double Coral::TraceClient::getJitter

(

const cardinal

layer = 0

)

const

Get jitter for given layer.

Parameters:

layer

Layer number.

Returns:

Jitter.

See also:

getLayers

cardinal Coral::TraceClient::getLayers

(

)

const [inline]

Get number of layers of last transmission.

card64 Coral::TraceClient::getMaxPosition

(

)

const [inline]

Get maximum media position.

Returns:

Maximum position in nanoseconds.

double Coral::TraceClient::getMaxTransferDelay

(

)

const [inline]

Get maximum transfer delay.

Returns:

Maximum transfer delay.

card64 Coral::TraceClient::getMaxWantedBandwidth

(

)

const [inline]

Get maximum wanted bandwidth.

Returns:

Maximum wanted bandwidth.

MediaInfo Coral::TraceClient::getMediaInfo

(

)

const

Get MediaInfo.

Returns:

MediaInfo.

card64 Coral::TraceClient::getMinWantedBandwidth

(

)

const [inline]

Get minimum wanted bandwidth.

Returns:

Minimum wanted bandwidth.

String Coral::TraceClient::getOurAddressString

(

InternetAddress::PrintFormat

format = InternetAddress::PF_Address

)

const

Get client address string.

Parameters:

format

Print format.

Returns:

Client address.

See also:

InternetAddress::PrintFormat

card32 Coral::TraceClient::getOurSSRC

(

)

const [inline]

Get client SSRC.

Returns:

Client SSRC.

card64 Coral::TraceClient::getPacketsLost

(

const cardinal

layer = 0

)

const

Get number of packets lost for given layer.

Parameters:

layer

Layer number.

Returns:

Number of packets lost.

See also:

getLayers

card64 Coral::TraceClient::getPacketsReceived

(

const cardinal

layer = 0

)

const [inline]

Get number of packets received in given layer.

Parameters:

layer

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

Returns:

Number of packets received

See also:

getLayers

card64 Coral::TraceClient::getPosition

(

)

Get current media position. This will automatically the RestartPosition value in the next TraceClientAppPacket. The server will restart from the current position, if the server is restarted.

Returns:

Position in nanoseconds.

String Coral::TraceClient::getServerAddressString

(

InternetAddress::PrintFormat

format = InternetAddress::PF_Address

)

const

Get server address string.

Parameters:

format

Print format.

Returns:

Server address.

See also:

InternetAddress::PrintFormat

card32 Coral::TraceClient::getServerSSRC

(

const cardinal

layer = 0

)

const

Get server SSRC for given layer.

Parameters:

layer

Layer number.

Returns:

Server SSRC.

See also:

getLayers

int8 Coral::TraceClient::getSessionPriority

(

)

const [inline]

Get session priority.

Returns:

Session priority;

int8 Coral::TraceClient::getStreamPriority

(

)

const [inline]

Get stream priority.

Returns:

Stream priority;

card8 Coral::TraceClient::getTrafficClass

(

const cardinal

layer = 0

)

const [inline]

Get traffic class of last received packet in given layer.

Parameters:

layer

Layer number.

Returns:

Traffic class.

See also:

getLayers

double Coral::TraceClient::getUtilization

(

)

const [inline]

Get utilization of last transmission.

Returns:

Utilization.

double Coral::TraceClient::getWantedUtilization

(

)

const [inline]

Get wanted utilization.

Returns:

Wanted utilization.

bool Coral::TraceClient::play	(	const char *	server,
		const char *	mediaName,
		const card32	sessionDescriptor = 0
	)

Start playing given media from given server.

Parameters:

server	Server address (e.g. gaffel:7500).
mediaName	Media name (e.g. ../TraceFiles/Test1.list)
sessionDescriptor	Session descriptor.

Returns:

true, if play request has been sent to server.

bool Coral::TraceClient::playing

(

)

const [inline]

Check, if trace client is playing.

Returns:

true, if client is playing; false otherwise.

void Coral::TraceClient::sendCommand

(

const bool

updateRestartPosition = true

)

[private]

void Coral::TraceClient::setEncoding

(

const cardinal

index

)

Set encoding by index in client's decoder repository.

Parameters:

index

Index in decoder repository.

void Coral::TraceClient::setFlags

(

const card32

priority

)

[inline]

Set flags.

Parameters:

flags

Flags.

void Coral::TraceClient::setMaxTransferDelay

(

const double

delay

)

[inline]

Set maximum transfer delay.

Parameters:

delay

Maximum transfer delay in microseconds.

void Coral::TraceClient::setMaxWantedBandwidth

(

const card64

bandwidth

)

[inline]

Set maximum wanted bandwidth.

Parameters:

bandwidth

Maximum wanted bandwidth.

void Coral::TraceClient::setMinWantedBandwidth

(

const card64

bandwidth

)

[inline]

Set minimum wanted bandwidth.

Parameters:

bandwidth

Minimum wanted bandwidth.

void Coral::TraceClient::setPause

(

const bool

on

)

Set pause.

Parameters:

on	true for pause on; false for pause off.

void Coral::TraceClient::setPosition

(

const card64

position

)

[inline]

Set media position.

Parameters:

position

New media position in nanoseconds.

void Coral::TraceClient::setSessionPriority

(

const int8

priority

)

[inline]

Set session priority.

Parameters:

priority

Session priority.

void Coral::TraceClient::setStreamPriority

(

const int8

priority

)

[inline]

Set stream priority.

Parameters:

priority

Stream priority.

void Coral::TraceClient::setWantedUtilization

(

const double

utilization

)

[inline]

Set wanted utilization.

Parameters:

utilization

Wanted utilization.

void Coral::TraceClient::stop

(

)

Stop playing.

---

Member Data Documentation

card64 Coral::TraceClient::ChangeTimeStamp [private]

TraceDecoderRepository Coral::TraceClient::Decoders [private]

multimap<const cardinal,TraceDecoderInterface*> Coral::TraceClient::DecoderSet [private]

InternetFlow Coral::TraceClient::Flow [private]

bool Coral::TraceClient::IsPlaying [private]

card64 Coral::TraceClient::OldPosition [private]

InternetAddress Coral::TraceClient::OurAddress [private]

card32 Coral::TraceClient::OurSSRC [private]

RTPReceiver* Coral::TraceClient::Receiver [private]

InternetAddress Coral::TraceClient::ReceiverAddress [private]

Socket Coral::TraceClient::ReceiverSocket [private]

const card64 Coral::TraceClient::RestartPositionUpdateDelay = 5000000 [static, private]

RTCPSender* Coral::TraceClient::Sender [private]

Socket Coral::TraceClient::SenderSocket [private]

InternetAddress Coral::TraceClient::ServerAddress [private]

TraceClientAppPacket Coral::TraceClient::Status [private]

---

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

• traceclient.h
• traceclient.cc