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 | List of all members
resip::SdpContents Class Reference

Provides an interface to process and generate SDP bodies (MIME content-type application/sdp). More...

#include <SdpContents.hxx>

Inheritance diagram for resip::SdpContents:
[legend]

Classes

class  Session
 Provides an interface to read and modify SDP bodies. More...
 

Public Types

enum  AddrType { IP4 =1 , IP6 }
 

Public Member Functions

 RESIP_HeapCount (SdpContents)
 
 SdpContents ()
 
 SdpContents (const HeaderFieldValue &hfv, const Mime &contentTypes)
 
virtual ~SdpContents ()
 
SdpContents & operator= (const SdpContents &rhs)
 
virtual Contents * clone () const
 duplicate an SdpContents object
 
Session & session ()
 get the parsed SDP
 
const Session & session () const
 
virtual EncodeStream & encodeParsed (EncodeStream &str) const
 
virtual void parse (ParseBuffer &pb)
 
- Public Member Functions inherited from resip::Contents
 Contents (const HeaderFieldValue &headerFieldValue, const Mime &contentsType)
 pass Mime instance for parameters
 
 Contents (const Mime &contentsType)
 Create a contents with a given mime type.
 
 Contents (const Contents &rhs)
 Copy constructor.
 
 Contents (const Contents &rhs, HeaderFieldValue::CopyPaddingEnum e)
 
 Contents (const HeaderFieldValue &headerFieldValue, HeaderFieldValue::CopyPaddingEnum e, const Mime &contentsType)
 
virtual ~Contents ()
 
Contents & operator= (const Contents &rhs)
 Assignment operator.
 
void preParseHeaders (ParseBuffer &pb)
 Preforms preparsing on the headers stored in the ParseBuffer pb.
 
EncodeStream & encodeHeaders (EncodeStream &str) const
 encodes headers to an output stream
 
virtual Contents * getContents ()
 access to wrapped contents (signed, encrypted)
 
Contents * getContents (const Mime &)
 
virtual Data getBodyData () const
 
const Mime & getType () const
 getter for mime type of message
 
bool exists (const HeaderBase &headerType) const
 checks to see if a header is present
 
void remove (const HeaderBase &headerType)
 removes a header if it is present
 
bool exists (const MIME_Header &headerType) const
 checks to see if a MIME header exists
 
void remove (const MIME_Header &headerType)
 removes a MIME header if it is present
 
const H_ContentType::Type & header (const H_ContentType &headerType) const
 returns the value of the Content-Type header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentType::Type & header (const H_ContentType &headerType)
 returns the value of the Content-Type header
 
const H_ContentDisposition::Type & header (const H_ContentDisposition &headerType) const
 returns the value of the Content-Disposition header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentDisposition::Type & header (const H_ContentDisposition &headerType)
 returns the value of the Content-Disposition header
 
const H_ContentTransferEncoding::Type & header (const H_ContentTransferEncoding &headerType) const
 returns the value of the Content-Transfer-Encoding header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentTransferEncoding::Type & header (const H_ContentTransferEncoding &headerType)
 returns the value of the Content-Transfer-Encoding header
 
const H_ContentLanguages::Type & header (const H_ContentLanguages &headerType) const
 returns the value of the Content-Languages header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentLanguages::Type & header (const H_ContentLanguages &headerType)
 returns the value of the Content-Languages header
 
const H_ContentID::Type & header (const H_ContentID &headerType) const
 returns the value of the Content-ID MIME header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentID::Type & header (const H_ContentID &headerType)
 returns the value of the Content-ID MIME header
 
const H_ContentDescription::Type & header (const H_ContentDescription &headerType) const
 returns the Content-Description MIME header Throws an Contents::Exception if the header doesn't exist.
 
H_ContentDescription::Type & header (const H_ContentDescription &headerType)
 returns the Content-Description MIME header
 
int & version ()
 returns the major version of MIME used by the contents
 
int & minorVersion ()
 returns the minor version of MIME used by the contents
 
void addBuffer (char *buf)
 
- Public Member Functions inherited from resip::LazyParser
 LazyParser (const HeaderFieldValue &headerFieldValue)
 
 LazyParser (const char *buf, int length)
 
 LazyParser (const HeaderFieldValue &headerFieldValue, HeaderFieldValue::CopyPaddingEnum e)
 
 LazyParser (const LazyParser &rhs)
 
 LazyParser (const LazyParser &rhs, HeaderFieldValue::CopyPaddingEnum e)
 
LazyParser & operator= (const LazyParser &rhs)
 
virtual ~LazyParser ()
 
EncodeStream & encode (EncodeStream &str) const
 Encodes this element to a stream, in the fashion it should be represented on the wire.
 
bool isParsed () const
 Returns true iff a parse has been attempted.
 
HeaderFieldValue & getHeaderField ()
 
void checkParsed () const
 
void checkParsed ()
 
void doParse () const
 
void markDirty () const
 
bool isWellFormed () const
 Returns true iff this element was parsed successfully, according to the implementation of parse().
 

Static Public Member Functions

static const Mime & getStaticType ()
 
static bool init ()
 
- Static Public Member Functions inherited from resip::Contents
static Contents * createContents (const Mime &contentType, const Data &contents)
 factory method to create a Contents object from a mime type and a payload
 

Static Public Attributes

static const SdpContents Empty
 

Additional Inherited Members

- Protected Member Functions inherited from resip::Contents
void clear ()
 
void init ()
 
void init (const Contents &orig)
 
void freeMem ()
 
virtual const Data & errorContext () const
 
- Protected Member Functions inherited from resip::LazyParser
 LazyParser ()
 
void clear ()
 
- Protected Attributes inherited from resip::Contents
Mime mType
 
H_ContentDisposition::Type * mDisposition
 
H_ContentTransferEncoding::Type * mTransferEncoding
 
H_ContentLanguages::Type * mLanguages
 
Token * mId
 
H_ContentDescription::Type * mDescription
 
StringCategory * mLength
 
int mVersion
 
int mMinorVersion
 
std::vector< char * > mBufferList
 

Detailed Description

Provides an interface to process and generate SDP bodies (MIME content-type application/sdp).

This class performs both the parsing and generation of SDP. Most interaction with the SDP will be through the Session object, accessible through the session() method.

Definition at line 58 of file SdpContents.hxx.

Member Enumeration Documentation

◆ AddrType

enum resip::SdpContents::AddrType
Enumerator
IP4 
IP6 

Definition at line 62 of file SdpContents.hxx.

Constructor & Destructor Documentation

◆ SdpContents() [1/2]

SdpContents::SdpContents ( )

Definition at line 184 of file SdpContents.cxx.

◆ SdpContents() [2/2]

SdpContents::SdpContents ( const HeaderFieldValue &  hfv,
const Mime &  contentTypes 
)

Definition at line 188 of file SdpContents.cxx.

◆ ~SdpContents()

SdpContents::~SdpContents ( )
virtual

Definition at line 199 of file SdpContents.cxx.

Member Function Documentation

◆ clone()

Contents * SdpContents::clone ( ) const
virtual

duplicate an SdpContents object

Returns
pointer to a new SdpContents object

Implements resip::Contents.

Definition at line 216 of file SdpContents.cxx.

◆ encodeParsed()

EncodeStream & SdpContents::encodeParsed ( EncodeStream &  str) const
virtual

Implements resip::LazyParser.

Definition at line 228 of file SdpContents.cxx.

◆ getStaticType()

const Mime & SdpContents::getStaticType ( )
static

Definition at line 235 of file SdpContents.cxx.

◆ init()

bool SdpContents::init ( )
static

Definition at line 36 of file SdpContents.cxx.

◆ operator=()

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

Definition at line 205 of file SdpContents.cxx.

◆ parse()

void SdpContents::parse ( ParseBuffer &  pb)
virtual

Implements resip::LazyParser.

Definition at line 222 of file SdpContents.cxx.

◆ RESIP_HeapCount()

resip::SdpContents::RESIP_HeapCount ( SdpContents  )

◆ session() [1/2]

Session & resip::SdpContents::session ( )
inline

get the parsed SDP

Returns
parsed SDP object

Definition at line 1178 of file SdpContents.hxx.

◆ session() [2/2]

const Session & resip::SdpContents::session ( ) const
inline

Definition at line 1179 of file SdpContents.hxx.

Member Data Documentation

◆ Empty

const SdpContents SdpContents::Empty
static

Definition at line 63 of file SdpContents.hxx.

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