JGRtpCandidates Class Reference

A list of RTP transport candidates. More...

#include <yatejingle.h>

Inheritance diagram for JGRtpCandidates:

Public Types
enum	Type {   Unknown = -1 , RtpIceUdp = 1 , RtpRawUdp , RtpP2P ,   RtpGoogleRawUdp }

Public Member Functions
	JGRtpCandidates (Type t=Unknown)
const char *	typeName () const
void	generateIceAuth ()
void	generateOldIceAuth ()
JGRtpCandidate *	findByComponent (unsigned int component)
XmlElement *	toXml (bool addCandidates, bool addAuth) const
void	fromXml (XmlElement *element)
Public Member Functions inherited from ObjList
	ObjList ()
virtual	~ObjList ()
virtual void *	getObject (const String &name) const
unsigned int	length () const
unsigned int	count () const
GenObject *	get () const
GenObject *	set (const GenObject *obj, bool delold=true)
ObjList *	next () const
ObjList *	last () const
ObjList *	skipNull () const
ObjList *	skipNext () const
GenObject *	at (int index) const
ObjList *	operator+ (int index) const
GenObject *	operator[] (signed int index) const
GenObject *	operator[] (unsigned int index) const
GenObject *	operator[] (const String &str) const
ObjList *	find (const GenObject *obj) const
ObjList *	find (const String &str) const
int	index (const GenObject *obj) const
int	index (const String &str) const
ObjList *	insert (const GenObject *obj, bool compact=true)
ObjList *	append (const GenObject *obj, bool compact=true)
ObjList *	setUnique (const GenObject *obj, bool compact=true)
GenObject *	remove (bool delobj=true)
GenObject *	remove (GenObject *obj, bool delobj=true)
GenObject *	remove (const String &str, bool delobj=true)
void	clear ()
void	compact ()
bool	autoDelete ()
void	setDelete (bool autodelete)
void	sort (int(*callbackCompare)(GenObject *obj1, GenObject *obj2, void *context), void *context=0)
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	toString () const
virtual const String &	traceId () const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

Static Public Member Functions
static void	generateIceToken (String &dest, bool pwd, unsigned int max=0)
static void	generateOldIceToken (String &dest)
static const char *	typeName (int t, const char *defVal="unknown")
Static Public Member Functions inherited from ObjList
static const ObjList &	empty ()
Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)
static bool	getObjCounting ()
static void	setObjCounting (bool enable)
static NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()

Public Attributes
Type	m_type
String	m_password
String	m_ufrag

Static Public Attributes
static const TokenDict	s_type []

Detailed Description

A list of RTP transport candidates.

This class holds a list of jingle RTP transport candidates

Member Enumeration Documentation

Type

enum Type

Enumeration of transport types

Constructor & Destructor Documentation

JGRtpCandidates()

JGRtpCandidates ( Type t = Unknown )

inline

Constructor. Fill this object from an XML element

Parameters

t	The transport type

Member Function Documentation

findByComponent()

JGRtpCandidate * findByComponent

(

unsigned int

component

)

Find a candidate by its component value

Parameters

component

The value to search

Returns

JGRtpCandidate pointer or 0

fromXml()

void fromXml

(

XmlElement *

element

)

Fill this object from a given element

Parameters

element

The element

generateIceAuth()

void generateIceAuth ( )

inline

Fill password and ufrag data

References generateIceToken().

generateIceToken()

static void generateIceToken ( String & dest, bool pwd, unsigned int max = 0 )

static

Generate a random password or username to be used with ICE-UDP transport

Parameters

dest	Destination string
pwd	True to generate a password, false to generate an username (ufrag)
max	Maximum number of characters. The maxmimum value is 256. The minimum value is 22 for password and 4 for username

Referenced by generateIceAuth().

generateOldIceAuth()

void generateOldIceAuth ( )

inline

Fill password and ufrag data using old transport restrictions (16 bytes length)

References generateOldIceToken().

generateOldIceToken()

static void generateOldIceToken ( String & dest )

static

Generate a random password or username to be used with old ICE-UDP transport

Parameters

dest	Destination string

Referenced by generateOldIceAuth().

toXml()

XmlElement * toXml	(	bool	addCandidates,
		bool	addAuth ) const

Create a 'transport' element from this object. Add candidates

Parameters

addCandidates	True to add the candidate children
addAuth	RtpIceUdp only: add auth data

Returns

Valid XmlElement pointer

typeName() [1/2]

const char * typeName ( ) const

inline

Get the name of this list's type

Returns

The name of this list's type

References typeName().

Referenced by typeName().

typeName() [2/2]

static const char * typeName ( int t, const char * defVal = "unknown" )

inlinestatic

Get the name associated with a list's type

Parameters

t	The desired type
defVal	Default value to return

Returns

The name associated with a list's type

References s_type.

Member Data Documentation

s_type

const TokenDict s_type[]

static

The list of type names

Referenced by typeName().

---

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

• yatejingle.h