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::Sdp Class Reference

#include <Sdp.hxx>

Classes

class  SdpBandwidth
 
class  SdpFoundation
 
class  SdpGroup
 
class  SdpTime
 
class  SdpTimeZone
 

Public Types

enum  SdpNetType { NET_TYPE_NONE , NET_TYPE_IN }
 
enum  SdpAddressType { ADDRESS_TYPE_NONE , ADDRESS_TYPE_IP4 , ADDRESS_TYPE_IP6 }
 
enum  SdpBandwidthType {
  BANDWIDTH_TYPE_NONE , BANDWIDTH_TYPE_CT , BANDWIDTH_TYPE_AS , BANDWIDTH_TYPE_TIAS ,
  BANDWIDTH_TYPE_RS , BANDWIDTH_TYPE_RR
}
 
enum  SdpConferenceType {
  CONFERENCE_TYPE_NONE , CONFERENCE_TYPE_BROADCAST , CONFERENCE_TYPE_MODERATED , CONFERENCE_TYPE_TEST ,
  CONFERENCE_TYPE_H332
}
 
enum  SdpGroupSemantics {
  GROUP_SEMANTICS_NONE , GROUP_SEMANTICS_LS , GROUP_SEMANTICS_FID , GROUP_SEMANTICS_SRF ,
  GROUP_SEMANTICS_ANAT
}
 
typedef std::list< resip::Data > EmailAddressList
 
typedef std::list< resip::Data > PhoneNumberList
 
typedef std::list< SdpBandwidth > BandwidthList
 
typedef std::list< SdpTime > TimeList
 
typedef std::list< SdpTimeZone > TimeZoneList
 
typedef std::list< SdpGroup > GroupList
 
typedef std::list< SdpMediaLine * > MediaLineList
 

Public Member Functions

 Sdp ()
 
 Sdp (const Sdp &rSdp)
 
virtual ~Sdp ()
 
Sdp & operator= (const Sdp &rhs)
 
void setSdpVersion (unsigned int sdpVersion)
 
void setOriginatorInfo (const char *userName, uint64_t sessionId, uint64_t sessionVersion, SdpNetType netType, SdpAddressType addressType, const char *unicastAddress)
 
void setOriginatorUserName (const char *originatorUserName)
 
void setOriginatorSessionId (uint64_t originatorSessionId)
 
void setOriginatorSessionVersion (uint64_t originatorSessionVersion)
 
void setOriginatorNetType (SdpNetType originatorNetType)
 
void setOriginatorAddressType (SdpAddressType originatorAddressType)
 
void setOriginatorUnicastAddress (const char *originatorUnicastAddress)
 
void setSessionName (const char *sessionName)
 
void setSessionInformation (const char *sessionInformation)
 
void setSessionUri (const char *sessionUri)
 
void addEmailAddress (const char *emailAddress)
 
void clearEmailAddresses ()
 
void addPhoneNumber (const char *phoneNumber)
 
void clearPhoneNumbers ()
 
void addBandwidth (SdpBandwidthType type, unsigned int bandwidth)
 
void addBandwidth (const SdpBandwidth &sdpBandwidth)
 
void clearBandwidths ()
 
void addTime (uint64_t startTime, uint64_t stopTime)
 
void addTime (const SdpTime &time)
 
void clearTimes ()
 
void addTimeZone (int adjustmentTime, int offset)
 
void addTimeZone (const SdpTimeZone &timeZone)
 
void clearTimeZones ()
 
void setCategory (const char *category)
 
void setKeywords (const char *keywords)
 
void setToolNameAndVersion (const char *toolNameAndVersion)
 
void setConferenceType (SdpConferenceType conferenceType)
 
void setCharSet (const char *charSet)
 
void setIcePassiveOnlyMode (bool icePassiveOnlyMode)
 
void addGroup (const SdpGroup &group)
 
void clearGroups ()
 
void setSessionLanguage (const char *sessionLanguage)
 
void setDescriptionLanguage (const char *descriptionLanguage)
 
void setMaximumPacketRate (double maximumPacketRate)
 
void addMediaLine (SdpMediaLine *mediaLine)
 
void clearMediaLines ()
 
void toString (resip::Data &sdpString) const
 
unsigned int getSdpVersion () const
 
const resip::Data & getOriginatorUserName () const
 
uint64_t getOriginatorSessionId () const
 
uint64_t getOriginatorSessionVersion () const
 
SdpNetType getOriginatorNetType () const
 
SdpAddressType getOriginatorAddressType () const
 
const resip::Data & getOriginatorUnicastAddress () const
 
const resip::Data & getSessionName () const
 
const resip::Data & getSessionInformation () const
 
const resip::Data & getSessionUri () const
 
const EmailAddressList & getEmailAddresses () const
 
const PhoneNumberList & getPhoneNumbers () const
 
const BandwidthList & getBandwidths () const
 
const TimeList & getTimes () const
 
const TimeZoneList & getTimeZones () const
 
const resip::Data & getCategory () const
 
const resip::Data & getKeywords () const
 
const resip::Data & getToolNameAndVersion () const
 
SdpConferenceType getConferenceType () const
 
const resip::Data & getCharSet () const
 
bool isIcePassiveOnlyMode () const
 
const GroupList & getGroups () const
 
const resip::Data & getSessionLanguage () const
 
const resip::Data & getDescriptionLanguage () const
 
double getMaximumPacketRate () const
 
const MediaLineList & getMediaLines () const
 
SdpMediaLine * getMediaLineAtIndex (int indexNumber)
 
resip::Data getLocalFoundationId (SdpCandidate::SdpCandidateType candidateType, const char *baseAddress, const char *stunAddress=0)
 

Static Public Member Functions

static SdpAddressType getAddressTypeFromString (const char *type)
 
static SdpConferenceType getConferenceTypeFromString (const char *type)
 

Static Public Attributes

static const char * SdpNetTypeString []
 
static const char * SdpAddressTypeString []
 
static const char * SdpBandwidthTypeString []
 
static const char * SdpConferenceTypeString []
 
static const char * SdpGroupSemanticsString []
 

Friends

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

Detailed Description

Definition at line 21 of file Sdp.hxx.

Member Typedef Documentation

◆ BandwidthList

typedef std::list<SdpBandwidth> sdpcontainer::Sdp::BandwidthList

Definition at line 270 of file Sdp.hxx.

◆ EmailAddressList

typedef std::list<resip::Data> sdpcontainer::Sdp::EmailAddressList

Definition at line 268 of file Sdp.hxx.

◆ GroupList

typedef std::list<SdpGroup> sdpcontainer::Sdp::GroupList

Definition at line 273 of file Sdp.hxx.

◆ MediaLineList

typedef std::list<SdpMediaLine*> sdpcontainer::Sdp::MediaLineList

Definition at line 274 of file Sdp.hxx.

◆ PhoneNumberList

typedef std::list<resip::Data> sdpcontainer::Sdp::PhoneNumberList

Definition at line 269 of file Sdp.hxx.

◆ TimeList

typedef std::list<SdpTime> sdpcontainer::Sdp::TimeList

Definition at line 271 of file Sdp.hxx.

◆ TimeZoneList

typedef std::list<SdpTimeZone> sdpcontainer::Sdp::TimeZoneList

Definition at line 272 of file Sdp.hxx.

Member Enumeration Documentation

◆ SdpAddressType

enum sdpcontainer::Sdp::SdpAddressType
Enumerator
ADDRESS_TYPE_NONE 
ADDRESS_TYPE_IP4 
ADDRESS_TYPE_IP6 

Definition at line 32 of file Sdp.hxx.

◆ SdpBandwidthType

enum sdpcontainer::Sdp::SdpBandwidthType
Enumerator
BANDWIDTH_TYPE_NONE 
BANDWIDTH_TYPE_CT 
BANDWIDTH_TYPE_AS 
BANDWIDTH_TYPE_TIAS 
BANDWIDTH_TYPE_RS 
BANDWIDTH_TYPE_RR 

Definition at line 40 of file Sdp.hxx.

◆ SdpConferenceType

enum sdpcontainer::Sdp::SdpConferenceType
Enumerator
CONFERENCE_TYPE_NONE 
CONFERENCE_TYPE_BROADCAST 
CONFERENCE_TYPE_MODERATED 
CONFERENCE_TYPE_TEST 
CONFERENCE_TYPE_H332 

Definition at line 137 of file Sdp.hxx.

◆ SdpGroupSemantics

enum sdpcontainer::Sdp::SdpGroupSemantics
Enumerator
GROUP_SEMANTICS_NONE 
GROUP_SEMANTICS_LS 
GROUP_SEMANTICS_FID 
GROUP_SEMANTICS_SRF 
GROUP_SEMANTICS_ANAT 

Definition at line 147 of file Sdp.hxx.

◆ SdpNetType

enum sdpcontainer::Sdp::SdpNetType
Enumerator
NET_TYPE_NONE 
NET_TYPE_IN 

Definition at line 25 of file Sdp.hxx.

Constructor & Destructor Documentation

◆ Sdp() [1/2]

Sdp::Sdp ( )

Definition at line 51 of file Sdp.cxx.

◆ Sdp() [2/2]

Sdp::Sdp ( const Sdp &  rSdp)

Definition at line 64 of file Sdp.cxx.

◆ ~Sdp()

Sdp::~Sdp ( )
virtual

Definition at line 70 of file Sdp.cxx.

Member Function Documentation

◆ addBandwidth() [1/2]

void sdpcontainer::Sdp::addBandwidth ( const SdpBandwidth &  sdpBandwidth)
inline

Definition at line 223 of file Sdp.hxx.

◆ addBandwidth() [2/2]

void sdpcontainer::Sdp::addBandwidth ( SdpBandwidthType  type,
unsigned int  bandwidth 
)
inline

Definition at line 222 of file Sdp.hxx.

◆ addEmailAddress()

void sdpcontainer::Sdp::addEmailAddress ( const char *  emailAddress)
inline

Definition at line 216 of file Sdp.hxx.

◆ addGroup()

void sdpcontainer::Sdp::addGroup ( const SdpGroup &  group)
inline

Definition at line 241 of file Sdp.hxx.

◆ addMediaLine()

void Sdp::addMediaLine ( SdpMediaLine *  mediaLine)

Definition at line 243 of file Sdp.cxx.

◆ addPhoneNumber()

void sdpcontainer::Sdp::addPhoneNumber ( const char *  phoneNumber)
inline

Definition at line 219 of file Sdp.hxx.

◆ addTime() [1/2]

void sdpcontainer::Sdp::addTime ( const SdpTime &  time)
inline

Definition at line 227 of file Sdp.hxx.

◆ addTime() [2/2]

void sdpcontainer::Sdp::addTime ( uint64_t  startTime,
uint64_t  stopTime 
)
inline

Definition at line 226 of file Sdp.hxx.

◆ addTimeZone() [1/2]

void sdpcontainer::Sdp::addTimeZone ( const SdpTimeZone &  timeZone)
inline

Definition at line 231 of file Sdp.hxx.

◆ addTimeZone() [2/2]

void sdpcontainer::Sdp::addTimeZone ( int  adjustmentTime,
int  offset 
)
inline

Definition at line 230 of file Sdp.hxx.

◆ clearBandwidths()

void sdpcontainer::Sdp::clearBandwidths ( )
inline

Definition at line 224 of file Sdp.hxx.

◆ clearEmailAddresses()

void sdpcontainer::Sdp::clearEmailAddresses ( )
inline

Definition at line 217 of file Sdp.hxx.

◆ clearGroups()

void sdpcontainer::Sdp::clearGroups ( )
inline

Definition at line 242 of file Sdp.hxx.

◆ clearMediaLines()

void Sdp::clearMediaLines ( )

Definition at line 249 of file Sdp.cxx.

◆ clearPhoneNumbers()

void sdpcontainer::Sdp::clearPhoneNumbers ( )
inline

Definition at line 220 of file Sdp.hxx.

◆ clearTimes()

void sdpcontainer::Sdp::clearTimes ( )
inline

Definition at line 228 of file Sdp.hxx.

◆ clearTimeZones()

void sdpcontainer::Sdp::clearTimeZones ( )
inline

Definition at line 232 of file Sdp.hxx.

◆ getAddressTypeFromString()

Sdp::SdpAddressType Sdp::getAddressTypeFromString ( const char *  type)
static

Definition at line 123 of file Sdp.cxx.

◆ getBandwidths()

const BandwidthList & sdpcontainer::Sdp::getBandwidths ( ) const
inline

Definition at line 278 of file Sdp.hxx.

◆ getCategory()

const resip::Data & sdpcontainer::Sdp::getCategory ( ) const
inline

Definition at line 282 of file Sdp.hxx.

◆ getCharSet()

const resip::Data & sdpcontainer::Sdp::getCharSet ( ) const
inline

Definition at line 287 of file Sdp.hxx.

◆ getConferenceType()

SdpConferenceType sdpcontainer::Sdp::getConferenceType ( ) const
inline

Definition at line 285 of file Sdp.hxx.

◆ getConferenceTypeFromString()

Sdp::SdpConferenceType Sdp::getConferenceTypeFromString ( const char *  type)
static

Definition at line 173 of file Sdp.cxx.

◆ getDescriptionLanguage()

const resip::Data & sdpcontainer::Sdp::getDescriptionLanguage ( ) const
inline

Definition at line 293 of file Sdp.hxx.

◆ getEmailAddresses()

const EmailAddressList & sdpcontainer::Sdp::getEmailAddresses ( ) const
inline

Definition at line 276 of file Sdp.hxx.

◆ getGroups()

const GroupList & sdpcontainer::Sdp::getGroups ( ) const
inline

Definition at line 290 of file Sdp.hxx.

◆ getKeywords()

const resip::Data & sdpcontainer::Sdp::getKeywords ( ) const
inline

Definition at line 283 of file Sdp.hxx.

◆ getLocalFoundationId()

resip::Data Sdp::getLocalFoundationId ( SdpCandidate::SdpCandidateType  candidateType,
const char *  baseAddress,
const char *  stunAddress = 0 
)

Definition at line 281 of file Sdp.cxx.

◆ getMaximumPacketRate()

double sdpcontainer::Sdp::getMaximumPacketRate ( ) const
inline

Definition at line 294 of file Sdp.hxx.

◆ getMediaLineAtIndex()

SdpMediaLine * Sdp::getMediaLineAtIndex ( int  indexNumber)

Definition at line 266 of file Sdp.cxx.

◆ getMediaLines()

const Sdp::MediaLineList & Sdp::getMediaLines ( ) const

Definition at line 260 of file Sdp.cxx.

◆ getOriginatorAddressType()

SdpAddressType sdpcontainer::Sdp::getOriginatorAddressType ( ) const
inline

Definition at line 261 of file Sdp.hxx.

◆ getOriginatorNetType()

SdpNetType sdpcontainer::Sdp::getOriginatorNetType ( ) const
inline

Definition at line 260 of file Sdp.hxx.

◆ getOriginatorSessionId()

uint64_t sdpcontainer::Sdp::getOriginatorSessionId ( ) const
inline

Definition at line 258 of file Sdp.hxx.

◆ getOriginatorSessionVersion()

uint64_t sdpcontainer::Sdp::getOriginatorSessionVersion ( ) const
inline

Definition at line 259 of file Sdp.hxx.

◆ getOriginatorUnicastAddress()

const resip::Data & sdpcontainer::Sdp::getOriginatorUnicastAddress ( ) const
inline

Definition at line 262 of file Sdp.hxx.

◆ getOriginatorUserName()

const resip::Data & sdpcontainer::Sdp::getOriginatorUserName ( ) const
inline

Definition at line 257 of file Sdp.hxx.

◆ getPhoneNumbers()

const PhoneNumberList & sdpcontainer::Sdp::getPhoneNumbers ( ) const
inline

Definition at line 277 of file Sdp.hxx.

◆ getSdpVersion()

unsigned int sdpcontainer::Sdp::getSdpVersion ( ) const
inline

Definition at line 255 of file Sdp.hxx.

◆ getSessionInformation()

const resip::Data & sdpcontainer::Sdp::getSessionInformation ( ) const
inline

Definition at line 265 of file Sdp.hxx.

◆ getSessionLanguage()

const resip::Data & sdpcontainer::Sdp::getSessionLanguage ( ) const
inline

Definition at line 292 of file Sdp.hxx.

◆ getSessionName()

const resip::Data & sdpcontainer::Sdp::getSessionName ( ) const
inline

Definition at line 264 of file Sdp.hxx.

◆ getSessionUri()

const resip::Data & sdpcontainer::Sdp::getSessionUri ( ) const
inline

Definition at line 266 of file Sdp.hxx.

◆ getTimes()

const TimeList & sdpcontainer::Sdp::getTimes ( ) const
inline

Definition at line 279 of file Sdp.hxx.

◆ getTimeZones()

const TimeZoneList & sdpcontainer::Sdp::getTimeZones ( ) const
inline

Definition at line 280 of file Sdp.hxx.

◆ getToolNameAndVersion()

const resip::Data & sdpcontainer::Sdp::getToolNameAndVersion ( ) const
inline

Definition at line 284 of file Sdp.hxx.

◆ isIcePassiveOnlyMode()

bool sdpcontainer::Sdp::isIcePassiveOnlyMode ( ) const
inline

Definition at line 288 of file Sdp.hxx.

◆ operator=()

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

Definition at line 77 of file Sdp.cxx.

◆ setCategory()

void sdpcontainer::Sdp::setCategory ( const char *  category)
inline

Definition at line 234 of file Sdp.hxx.

◆ setCharSet()

void sdpcontainer::Sdp::setCharSet ( const char *  charSet)
inline

Definition at line 238 of file Sdp.hxx.

◆ setConferenceType()

void sdpcontainer::Sdp::setConferenceType ( SdpConferenceType  conferenceType)
inline

Definition at line 237 of file Sdp.hxx.

◆ setDescriptionLanguage()

void sdpcontainer::Sdp::setDescriptionLanguage ( const char *  descriptionLanguage)
inline

Definition at line 245 of file Sdp.hxx.

◆ setIcePassiveOnlyMode()

void sdpcontainer::Sdp::setIcePassiveOnlyMode ( bool  icePassiveOnlyMode)
inline

Definition at line 239 of file Sdp.hxx.

◆ setKeywords()

void sdpcontainer::Sdp::setKeywords ( const char *  keywords)
inline

Definition at line 235 of file Sdp.hxx.

◆ setMaximumPacketRate()

void sdpcontainer::Sdp::setMaximumPacketRate ( double  maximumPacketRate)
inline

Definition at line 246 of file Sdp.hxx.

◆ setOriginatorAddressType()

void sdpcontainer::Sdp::setOriginatorAddressType ( SdpAddressType  originatorAddressType)
inline

Definition at line 209 of file Sdp.hxx.

◆ setOriginatorInfo()

void Sdp::setOriginatorInfo ( const char *  userName,
uint64_t  sessionId,
uint64_t  sessionVersion,
SdpNetType  netType,
SdpAddressType  addressType,
const char *  unicastAddress 
)

Definition at line 227 of file Sdp.cxx.

◆ setOriginatorNetType()

void sdpcontainer::Sdp::setOriginatorNetType ( SdpNetType  originatorNetType)
inline

Definition at line 208 of file Sdp.hxx.

◆ setOriginatorSessionId()

void sdpcontainer::Sdp::setOriginatorSessionId ( uint64_t  originatorSessionId)
inline

Definition at line 206 of file Sdp.hxx.

◆ setOriginatorSessionVersion()

void sdpcontainer::Sdp::setOriginatorSessionVersion ( uint64_t  originatorSessionVersion)
inline

Definition at line 207 of file Sdp.hxx.

◆ setOriginatorUnicastAddress()

void sdpcontainer::Sdp::setOriginatorUnicastAddress ( const char *  originatorUnicastAddress)
inline

Definition at line 210 of file Sdp.hxx.

◆ setOriginatorUserName()

void sdpcontainer::Sdp::setOriginatorUserName ( const char *  originatorUserName)
inline

Definition at line 205 of file Sdp.hxx.

◆ setSdpVersion()

void sdpcontainer::Sdp::setSdpVersion ( unsigned int  sdpVersion)
inline

Definition at line 202 of file Sdp.hxx.

◆ setSessionInformation()

void sdpcontainer::Sdp::setSessionInformation ( const char *  sessionInformation)
inline

Definition at line 213 of file Sdp.hxx.

◆ setSessionLanguage()

void sdpcontainer::Sdp::setSessionLanguage ( const char *  sessionLanguage)
inline

Definition at line 244 of file Sdp.hxx.

◆ setSessionName()

void sdpcontainer::Sdp::setSessionName ( const char *  sessionName)
inline

Definition at line 212 of file Sdp.hxx.

◆ setSessionUri()

void sdpcontainer::Sdp::setSessionUri ( const char *  sessionUri)
inline

Definition at line 214 of file Sdp.hxx.

◆ setToolNameAndVersion()

void sdpcontainer::Sdp::setToolNameAndVersion ( const char *  toolNameAndVersion)
inline

Definition at line 236 of file Sdp.hxx.

◆ toString()

void sdpcontainer::Sdp::toString ( resip::Data &  sdpString) const

Friends And Related Symbol Documentation

◆ operator<<

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

Member Data Documentation

◆ SdpAddressTypeString

const char * Sdp::SdpAddressTypeString
static
Initial value:
=
{
"NONE",
"IP4",
"IP6"
}

Definition at line 38 of file Sdp.hxx.

◆ SdpBandwidthTypeString

const char * Sdp::SdpBandwidthTypeString
static
Initial value:
=
{
"NONE",
"CT",
"AS",
"TIAS",
"RS",
"RR"
}

Definition at line 49 of file Sdp.hxx.

◆ SdpConferenceTypeString

const char * Sdp::SdpConferenceTypeString
static
Initial value:
=
{
"NONE",
"BROADCAST",
"MODERATED",
"TEST",
"H332"
}

Definition at line 145 of file Sdp.hxx.

◆ SdpGroupSemanticsString

const char * Sdp::SdpGroupSemanticsString
static
Initial value:
=
{
"NONE",
"LS",
"FID",
"SRF",
"ANAT"
}

Definition at line 155 of file Sdp.hxx.

◆ SdpNetTypeString

const char * Sdp::SdpNetTypeString
static
Initial value:
=
{
"NONE",
"IN"
}

Definition at line 30 of file Sdp.hxx.

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