sipXtapi home page


Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
SdpCandidate Class Reference

#include <SdpCandidate.h>

Inheritance diagram for SdpCandidate:
Inheritance graph
[legend]
Collaboration diagram for SdpCandidate:
Collaboration graph
[legend]

Classes

class  SdpCandidateExtensionAttribute
 

Public Types

enum  SdpCandidateTransportType {
  CANDIDATE_TRANSPORT_TYPE_NONE, CANDIDATE_TRANSPORT_TYPE_UDP, CANDIDATE_TRANSPORT_TYPE_TCP_SO, CANDIDATE_TRANSPORT_TYPE_TCP_ACT,
  CANDIDATE_TRANSPORT_TYPE_TCP_PASS, CANDIDATE_TRANSPORT_TYPE_TLS_SO, CANDIDATE_TRANSPORT_TYPE_TLS_ACT, CANDIDATE_TRANSPORT_TYPE_TLS_PASS
}
 
enum  SdpCandidateType {
  CANDIDATE_TYPE_NONE, CANDIDATE_TYPE_HOST, CANDIDATE_TYPE_SRFLX, CANDIDATE_TYPE_PRFLX,
  CANDIDATE_TYPE_RELAY
}
 

Public Member Functions

 SdpCandidate (const char *foundation=0, unsigned int id=0, SdpCandidateTransportType transport=CANDIDATE_TRANSPORT_TYPE_NONE, uint64_t priority=0, const char *connectionAddress=0, unsigned int port=0, SdpCandidateType candidateType=CANDIDATE_TYPE_NONE, const char *relatedAddress=0, unsigned int relatedPort=0, bool inUse=false)
 
 SdpCandidate (const SdpCandidate &rSdpCandidate)
 
virtual ~SdpCandidate ()
 
SdpCandidateoperator= (const SdpCandidate &rhs)
 
void setFoundation (const char *foundation)
 
void setId (unsigned int id)
 
void setTransport (SdpCandidateTransportType transport)
 
void setPriority (uint64_t priority)
 
void setConnectionAddress (const char *connectionAddress)
 
void setPort (unsigned int port)
 
void setCandidateType (SdpCandidateType candidateType)
 
void setRelatedAddress (const char *relatedAddress)
 
void setRelatedPort (unsigned int relatedPort)
 
void addExtensionAttribute (const char *name, const char *value)
 
void addExtensionAttribute (SdpCandidateExtensionAttribute *sdpCandidateExtensionAttribute)
 
void clearExtensionAttributes ()
 
void setInUse (bool inUse)
 
virtual UtlContainableType getContainableType () const
 
virtual unsigned hash () const
 
virtual int compareTo (UtlContainable const *) const
 
UtlCopyableContainable * clone () const
 
void toString (UtlString &sdpCandidateString) const
 
virtual UtlBoolean isInstanceOf (const UtlContainableType type) const
 
const UtlString & getFoundation () const
 
unsigned int getId () const
 
SdpCandidateTransportType getTransport () const
 
uint64_t getPriority () const
 
const UtlString & getConnectionAddress () const
 
unsigned int getPort () const
 
SdpCandidateType getCandidateType () const
 
const UtlString & getRelatedAddress () const
 
unsigned int getRelatedPort () const
 
const UtlCopyableSList & getExtensionAttributes () const
 
bool isInUse () const
 

Static Public Member Functions

static SdpCandidateTransportType getCandidateTransportTypeFromString (const char *type)
 
static SdpCandidateType getCandidateTypeFromString (const char *type)
 

Static Public Attributes

static const char * SdpCandidateTransportTypeString []
 
static const char * SdpCandidateTypeString []
 
static const UtlContainableType TYPE = "SdpCandidate"
 Class type used for runtime checking. More...
 

Private Member Functions

int compareNumber (uint64_t first, uint64_t second, bool reverse=false) const
 

Private Attributes

UtlString mFoundation
 
unsigned int mId
 
SdpCandidateTransportType mTransport
 
uint64_t mPriority
 
UtlString mConnectionAddress
 
unsigned int mPort
 
SdpCandidateType mCandidateType
 
UtlString mRelatedAddress
 
unsigned int mRelatedPort
 
UtlCopyableSList mExtensionAttributes
 
bool mInUse
 

Member Enumeration Documentation

Enumerator
CANDIDATE_TRANSPORT_TYPE_NONE 
CANDIDATE_TRANSPORT_TYPE_UDP 
CANDIDATE_TRANSPORT_TYPE_TCP_SO 
CANDIDATE_TRANSPORT_TYPE_TCP_ACT 
CANDIDATE_TRANSPORT_TYPE_TCP_PASS 
CANDIDATE_TRANSPORT_TYPE_TLS_SO 
CANDIDATE_TRANSPORT_TYPE_TLS_ACT 
CANDIDATE_TRANSPORT_TYPE_TLS_PASS 
Enumerator
CANDIDATE_TYPE_NONE 
CANDIDATE_TYPE_HOST 
CANDIDATE_TYPE_SRFLX 
CANDIDATE_TYPE_PRFLX 
CANDIDATE_TYPE_RELAY 

Constructor & Destructor Documentation

SdpCandidate ( const char *  foundation = 0,
unsigned int  id = 0,
SdpCandidateTransportType  transport = CANDIDATE_TRANSPORT_TYPE_NONE,
uint64_t  priority = 0,
const char *  connectionAddress = 0,
unsigned int  port = 0,
SdpCandidateType  candidateType = CANDIDATE_TYPE_NONE,
const char *  relatedAddress = 0,
unsigned int  relatedPort = 0,
bool  inUse = false 
)
SdpCandidate ( const SdpCandidate rSdpCandidate)
~SdpCandidate ( )
virtual

Member Function Documentation

void addExtensionAttribute ( const char *  name,
const char *  value 
)
inline
void addExtensionAttribute ( SdpCandidateExtensionAttribute sdpCandidateExtensionAttribute)
inline
void clearExtensionAttributes ( )
inline
UtlCopyableContainable* clone ( ) const
inline
int compareNumber ( uint64_t  first,
uint64_t  second,
bool  reverse = false 
) const
private
int compareTo ( UtlContainable const *  rhs) const
virtual
SdpCandidate::SdpCandidateTransportType getCandidateTransportTypeFromString ( const char *  type)
static
SdpCandidateType getCandidateType ( ) const
inline
SdpCandidate::SdpCandidateType getCandidateTypeFromString ( const char *  type)
static
const UtlString& getConnectionAddress ( ) const
inline
UtlContainableType getContainableType ( ) const
virtual
const UtlCopyableSList& getExtensionAttributes ( ) const
inline
const UtlString& getFoundation ( ) const
inline
unsigned int getId ( ) const
inline
unsigned int getPort ( ) const
inline
uint64_t getPriority ( ) const
inline
const UtlString& getRelatedAddress ( ) const
inline
unsigned int getRelatedPort ( ) const
inline
SdpCandidateTransportType getTransport ( ) const
inline
unsigned hash ( ) const
virtual
UtlBoolean isInstanceOf ( const UtlContainableType  type) const
virtual
bool isInUse ( ) const
inline
SdpCandidate & operator= ( const SdpCandidate rhs)
void setCandidateType ( SdpCandidateType  candidateType)
inline
void setConnectionAddress ( const char *  connectionAddress)
inline
void setFoundation ( const char *  foundation)
inline
void setId ( unsigned int  id)
inline
void setInUse ( bool  inUse)
inline
void setPort ( unsigned int  port)
inline
void setPriority ( uint64_t  priority)
inline
void setRelatedAddress ( const char *  relatedAddress)
inline
void setRelatedPort ( unsigned int  relatedPort)
inline
void setTransport ( SdpCandidateTransportType  transport)
inline
void toString ( UtlString &  sdpCandidateString) const

Member Data Documentation

SdpCandidateType mCandidateType
private
UtlString mConnectionAddress
private
UtlCopyableSList mExtensionAttributes
private
UtlString mFoundation
private
unsigned int mId
private
bool mInUse
private
unsigned int mPort
private
uint64_t mPriority
private
UtlString mRelatedAddress
private
unsigned int mRelatedPort
private
SdpCandidateTransportType mTransport
private
const char * SdpCandidateTransportTypeString
static
Initial value:
=
{
"NONE",
"UDP",
"TCP-SO",
"TCP-ACT",
"TCP-PASS",
"TLS-SO",
"TLS-ACT",
"TLS-PASS"
}
const char * SdpCandidateTypeString
static
Initial value:
=
{
"NONE",
"HOST",
"SRFLX",
"PRFLX",
"RELAY"
}
const UtlContainableType TYPE = "SdpCandidate"
static

Class type used for runtime checking.