reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
sdpcontainer::SdpCandidate Class Reference

#include <SdpCandidate.hxx>

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
}
 
typedef std::list< SdpCandidateExtensionAttribute > SdpCandidateExtensionAttributeList
 

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 ()
 
SdpCandidate & operator= (const SdpCandidate &rhs)
 
bool operator< (const SdpCandidate &rhs) const
 
bool operator== (const SdpCandidate &rhs) const
 
bool operator!= (const SdpCandidate &rhs) const
 
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 (const SdpCandidateExtensionAttribute &sdpCandidateExtensionAttribute)
 
void clearExtensionAttributes ()
 
void setInUse (bool inUse)
 
void toString (resip::Data &sdpCandidateString) const
 
const resip::Data & getFoundation () const
 
unsigned int getId () const
 
SdpCandidateTransportType getTransport () const
 
uint64_t getPriority () const
 
const resip::Data & getConnectionAddress () const
 
unsigned int getPort () const
 
SdpCandidateType getCandidateType () const
 
const resip::Data & getRelatedAddress () const
 
unsigned int getRelatedPort () const
 
const SdpCandidateExtensionAttributeList & 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 []
 

Friends

EncodeStream & operator<< (EncodeStream &strm, const SdpCandidate &)
 

Detailed Description

Definition at line 11 of file SdpCandidate.hxx.

Member Typedef Documentation

◆ SdpCandidateExtensionAttributeList

typedef std::list<SdpCandidateExtensionAttribute> sdpcontainer::SdpCandidate::SdpCandidateExtensionAttributeList

Definition at line 72 of file SdpCandidate.hxx.

Member Enumeration Documentation

◆ SdpCandidateTransportType

enum sdpcontainer::SdpCandidate::SdpCandidateTransportType
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 

Definition at line 15 of file SdpCandidate.hxx.

◆ SdpCandidateType

enum sdpcontainer::SdpCandidate::SdpCandidateType
Enumerator
CANDIDATE_TYPE_NONE 
CANDIDATE_TYPE_HOST 
CANDIDATE_TYPE_SRFLX 
CANDIDATE_TYPE_PRFLX 
CANDIDATE_TYPE_RELAY 

Definition at line 28 of file SdpCandidate.hxx.

Constructor & Destructor Documentation

◆ SdpCandidate() [1/2]

SdpCandidate::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 
)

Definition at line 27 of file SdpCandidate.cxx.

◆ SdpCandidate() [2/2]

SdpCandidate::SdpCandidate ( const SdpCandidate &  rSdpCandidate)

Definition at line 51 of file SdpCandidate.cxx.

◆ ~SdpCandidate()

SdpCandidate::~SdpCandidate ( )
virtual

Definition at line 57 of file SdpCandidate.cxx.

Member Function Documentation

◆ addExtensionAttribute() [1/2]

void sdpcontainer::SdpCandidate::addExtensionAttribute ( const char *  name,
const char *  value 
)
inline

Definition at line 89 of file SdpCandidate.hxx.

◆ addExtensionAttribute() [2/2]

void sdpcontainer::SdpCandidate::addExtensionAttribute ( const SdpCandidateExtensionAttribute &  sdpCandidateExtensionAttribute)
inline

Definition at line 90 of file SdpCandidate.hxx.

◆ clearExtensionAttributes()

void sdpcontainer::SdpCandidate::clearExtensionAttributes ( )
inline

Definition at line 91 of file SdpCandidate.hxx.

◆ getCandidateTransportTypeFromString()

SdpCandidate::SdpCandidateTransportType SdpCandidate::getCandidateTransportTypeFromString ( const char *  type)
static

Definition at line 158 of file SdpCandidate.cxx.

◆ getCandidateType()

SdpCandidateType sdpcontainer::SdpCandidate::getCandidateType ( ) const
inline

Definition at line 104 of file SdpCandidate.hxx.

◆ getCandidateTypeFromString()

SdpCandidate::SdpCandidateType SdpCandidate::getCandidateTypeFromString ( const char *  type)
static

Definition at line 197 of file SdpCandidate.cxx.

◆ getConnectionAddress()

const resip::Data & sdpcontainer::SdpCandidate::getConnectionAddress ( ) const
inline

Definition at line 102 of file SdpCandidate.hxx.

◆ getExtensionAttributes()

const SdpCandidateExtensionAttributeList & sdpcontainer::SdpCandidate::getExtensionAttributes ( ) const
inline

Definition at line 108 of file SdpCandidate.hxx.

◆ getFoundation()

const resip::Data & sdpcontainer::SdpCandidate::getFoundation ( ) const
inline

Definition at line 97 of file SdpCandidate.hxx.

◆ getId()

unsigned int sdpcontainer::SdpCandidate::getId ( ) const
inline

Definition at line 98 of file SdpCandidate.hxx.

◆ getPort()

unsigned int sdpcontainer::SdpCandidate::getPort ( ) const
inline

Definition at line 103 of file SdpCandidate.hxx.

◆ getPriority()

uint64_t sdpcontainer::SdpCandidate::getPriority ( ) const
inline

Definition at line 101 of file SdpCandidate.hxx.

◆ getRelatedAddress()

const resip::Data & sdpcontainer::SdpCandidate::getRelatedAddress ( ) const
inline

Definition at line 106 of file SdpCandidate.hxx.

◆ getRelatedPort()

unsigned int sdpcontainer::SdpCandidate::getRelatedPort ( ) const
inline

Definition at line 107 of file SdpCandidate.hxx.

◆ getTransport()

SdpCandidateTransportType sdpcontainer::SdpCandidate::getTransport ( ) const
inline

Definition at line 99 of file SdpCandidate.hxx.

◆ isInUse()

bool sdpcontainer::SdpCandidate::isInUse ( ) const
inline

Definition at line 109 of file SdpCandidate.hxx.

◆ operator!=()

bool SdpCandidate::operator!= ( const SdpCandidate &  rhs) const

Definition at line 100 of file SdpCandidate.cxx.

◆ operator<()

bool SdpCandidate::operator< ( const SdpCandidate &  rhs) const

Definition at line 105 of file SdpCandidate.cxx.

◆ operator=()

SdpCandidate & SdpCandidate::operator= ( const SdpCandidate &  rhs)

Definition at line 62 of file SdpCandidate.cxx.

◆ operator==()

bool SdpCandidate::operator== ( const SdpCandidate &  rhs) const

Definition at line 84 of file SdpCandidate.cxx.

◆ setCandidateType()

void sdpcontainer::SdpCandidate::setCandidateType ( SdpCandidateType  candidateType)
inline

Definition at line 85 of file SdpCandidate.hxx.

◆ setConnectionAddress()

void sdpcontainer::SdpCandidate::setConnectionAddress ( const char *  connectionAddress)
inline

Definition at line 83 of file SdpCandidate.hxx.

◆ setFoundation()

void sdpcontainer::SdpCandidate::setFoundation ( const char *  foundation)
inline

Definition at line 79 of file SdpCandidate.hxx.

◆ setId()

void sdpcontainer::SdpCandidate::setId ( unsigned int  id)
inline

Definition at line 80 of file SdpCandidate.hxx.

◆ setInUse()

void sdpcontainer::SdpCandidate::setInUse ( bool  inUse)
inline

Definition at line 93 of file SdpCandidate.hxx.

◆ setPort()

void sdpcontainer::SdpCandidate::setPort ( unsigned int  port)
inline

Definition at line 84 of file SdpCandidate.hxx.

◆ setPriority()

void sdpcontainer::SdpCandidate::setPriority ( uint64_t  priority)
inline

Definition at line 82 of file SdpCandidate.hxx.

◆ setRelatedAddress()

void sdpcontainer::SdpCandidate::setRelatedAddress ( const char *  relatedAddress)
inline

Definition at line 86 of file SdpCandidate.hxx.

◆ setRelatedPort()

void sdpcontainer::SdpCandidate::setRelatedPort ( unsigned int  relatedPort)
inline

Definition at line 87 of file SdpCandidate.hxx.

◆ setTransport()

void sdpcontainer::SdpCandidate::setTransport ( SdpCandidateTransportType  transport)
inline

Definition at line 81 of file SdpCandidate.hxx.

◆ toString()

void sdpcontainer::SdpCandidate::toString ( resip::Data &  sdpCandidateString) const

Friends And Related Symbol Documentation

◆ operator<<

EncodeStream & operator<< ( EncodeStream &  strm,
const SdpCandidate &   
)
friend

Member Data Documentation

◆ SdpCandidateTransportTypeString

const char * SdpCandidate::SdpCandidateTransportTypeString
static
Initial value:
=
{
"NONE",
"UDP",
"TCP-SO",
"TCP-ACT",
"TCP-PASS",
"TLS-SO",
"TLS-ACT",
"TLS-PASS"
}

Definition at line 26 of file SdpCandidate.hxx.

◆ SdpCandidateTypeString

const char * SdpCandidate::SdpCandidateTypeString
static
Initial value:
=
{
"NONE",
"HOST",
"SRFLX",
"PRFLX",
"RELAY"
}

Definition at line 36 of file SdpCandidate.hxx.

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