class JGRtpCandidates

A list of RTP transport candidates. More...

Full nameTelEngine::JGRtpCandidates
Definition#include <libs/yjabber/yatejingle.h>
InheritsTelEngine::ObjList [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods

Public Members


Detailed Description

This class holds a list of jingle RTP transport candidates

enum Type { Unknown = -1, RtpIceUdp = 1, RtpRawUdp = 2, }

Type

Enumeration of transport types

inline  JGRtpCandidates (Type t = Unknown)

JGRtpCandidates

Constructor. Fill this object from an XML element

Parameters:
tThe transport type

inline const char*  typeName ()

typeName

[const]

Get the name of this list's type

Returns: The name of this list's type

inline void  generateIceAuth ()

generateIceAuth

Fill password and ufrag data

inline void  generateOldIceAuth ()

generateOldIceAuth

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

JGRtpCandidate*  findByComponent (unsigned int component)

findByComponent

Find a candidate by its component value

Parameters:
componentThe value to search

Returns: JGRtpCandidate pointer or 0

XmlElement*  toXml (bool addCandidates, bool addAuth)

toXml

[const]

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

Parameters:
addCandidatesTrue to add the candidate children
addAuthRtpIceUdp only: add auth data

Returns: Valid XmlElement pointer

void  fromXml (XmlElement* element)

fromXml

Fill this object from a given element

Parameters:
elementThe element

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

generateIceToken

[static]

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

Parameters:
destDestination string
pwdTrue to generate a password, false to generate an username (ufrag)
maxMaximum number of characters. The maxmimum value is 256. The minimum value is 22 for password and 4 for username

void  generateOldIceToken (String& dest)

generateOldIceToken

[static]

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

Parameters:
destDestination string

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

typeName

[static]

Get the name associated with a list's type

Parameters:
tThe desired type
defValDefault value to return

Returns: The name associated with a list's type

static const TokenDict s_type[]

s_type[]

Type m_type

m_type

String m_password

m_password

String m_ufrag

m_ufrag


Generated by: paulc on bussard on Tue Mar 8 18:42:27 2011, using kdoc 2.0a54.