SIPMIMEInfo Class Reference

#include <sippdu.h>

List of all members.

Public Member Functions
	SIPMIMEInfo (BOOL compactForm=FALSE)
void	SetForm (BOOL v)
PString	GetContentType () const
void	SetContentType (const PString &v)
PString	GetContentEncoding () const
void	SetContentEncoding (const PString &v)
PString	GetFrom () const
void	SetFrom (const PString &v)
PString	GetAccept () const
void	SetAccept (const PString &v)
PString	GetAcceptEncoding () const
void	SetAcceptEncoding (const PString &v)
PString	GetAcceptLanguage () const
void	SetAcceptLanguage (const PString &v)
PString	GetAllow () const
void	SetAllow (const PString &v)
PString	GetCallID () const
void	SetCallID (const PString &v)
PString	GetContact () const
void	SetContact (const PString &v)
void	SetContact (const SIPURL &url)
PString	GetSubject () const
void	SetSubject (const PString &v)
PString	GetTo () const
void	SetTo (const PString &v)
PString	GetVia () const
void	SetVia (const PString &v)
PStringList	GetViaList () const
void	SetViaList (const PStringList &v)
PString	GetReferTo () const
void	SetReferTo (const PString &r)
PINDEX	GetContentLength () const
void	SetContentLength (PINDEX v)
PString	GetCSeq () const
void	SetCSeq (const PString &v)
PString	GetDate () const
void	SetDate (const PString &v)
void	SetDate (const PTime &t)
void	SetDate (void)
unsigned	GetExpires (unsigned dflt=UINT_MAX) const
void	SetExpires (unsigned v)
PINDEX	GetMaxForwards () const
void	SetMaxForwards (PINDEX v)
PINDEX	GetMinExpires () const
void	SetMinExpires (PINDEX v)
PString	GetProxyAuthenticate () const
void	SetProxyAuthenticate (const PString &v)
PStringList	GetRoute () const
void	SetRoute (const PStringList &v)
PStringList	GetRecordRoute () const
void	SetRecordRoute (const PStringList &v)
unsigned	GetCSeqIndex () const
PString	GetSupported () const
void	SetSupported (const PString &v)
PString	GetUnsupported () const
void	SetUnsupported (const PString &v)
PString	GetEvent () const
void	SetEvent (const PString &v)
PString	GetSubscriptionState () const
void	SetSubscriptionState (const PString &v)
PString	GetUserAgent () const
void	SetUserAgent (const SIPEndPoint &sipep)
PString	GetWWWAuthenticate () const
void	SetWWWAuthenticate (const PString &v)
PString	GetFieldParameter (const PString &, const PString &)
void	SetFieldParameter (const PString &, PString &, const PString &)
BOOL	HasFieldParameter (const PString &, const PString &)
Protected Member Functions
PStringList	GetRouteList (const char *name) const
void	SetRouteList (const char *name, const PStringList &v)
PString	GetFullOrCompact (const char *fullForm, char compactForm) const
Protected Attributes
BOOL	compactForm
	Encode using compact form.

---

Detailed Description

Session Initiation Protocol MIME info container This is a string dictionary: for each item mime header is key, value is value. Headers may be full ("From") or compact ("f"). Colons not included. PMIMEInfo::ReadFrom (>>) parses from stream. That adds a header-value element for each mime line. If a mime header is duplicated in the stream then the additional value is appended to the existing, separated by "/n". PMIMEInfo::ReadFrom supports multi-line values if the next line starts with a space - it just appends the next line to the existing string with the separating space. There is no checking of header names or values. compactForm decides whether 'Set' methods store full or compact headers. 'Set' methods replace values, there is no method for appending except ReadFrom. 'Get' methods work whether stored headers are full or compact.

to do to satisfy RFC3261 (mandatory(*) & should): Accept Accept-Encoding Accept-Language Allow Max-Forwards Min-Expires Proxy-Authenticate Supported Unsupported WWW-Authenticate

---

Constructor & Destructor Documentation

SIPMIMEInfo::SIPMIMEInfo (  BOOL  compactForm = FALSE  )

---

Member Function Documentation

PString SIPMIMEInfo::GetAccept (   )  const

PString SIPMIMEInfo::GetAcceptEncoding (   )  const

PString SIPMIMEInfo::GetAcceptLanguage (   )  const

PString SIPMIMEInfo::GetAllow (   )  const

PString SIPMIMEInfo::GetCallID (   )  const

PString SIPMIMEInfo::GetContact (   )  const

PString SIPMIMEInfo::GetContentEncoding (   )  const

PINDEX SIPMIMEInfo::GetContentLength (   )  const

PString SIPMIMEInfo::GetContentType (   )  const

PString SIPMIMEInfo::GetCSeq (   )  const

unsigned SIPMIMEInfo::GetCSeqIndex (   )  const [inline]

PString SIPMIMEInfo::GetDate (   )  const

PString SIPMIMEInfo::GetEvent (   )  const

unsigned SIPMIMEInfo::GetExpires (  unsigned  dflt = UINT_MAX  )  const

PString SIPMIMEInfo::GetFieldParameter (  const PString &  , const PString &  )

return the value of a header field parameter, empty if none

PString SIPMIMEInfo::GetFrom (   )  const

PString SIPMIMEInfo::GetFullOrCompact (  const char *  fullForm, char  compactForm )  const [protected]

return string keyed by full or compact header

PINDEX SIPMIMEInfo::GetMaxForwards (   )  const

PINDEX SIPMIMEInfo::GetMinExpires (   )  const

PString SIPMIMEInfo::GetProxyAuthenticate (   )  const

PStringList SIPMIMEInfo::GetRecordRoute (   )  const

PString SIPMIMEInfo::GetReferTo (   )  const

PStringList SIPMIMEInfo::GetRoute (   )  const

PStringList SIPMIMEInfo::GetRouteList (  const char *  name  )  const [protected]

return list of route values from internal comma-delimited list

PString SIPMIMEInfo::GetSubject (   )  const

PString SIPMIMEInfo::GetSubscriptionState (   )  const

PString SIPMIMEInfo::GetSupported (   )  const

PString SIPMIMEInfo::GetTo (   )  const

PString SIPMIMEInfo::GetUnsupported (   )  const

PString SIPMIMEInfo::GetUserAgent (   )  const

PString SIPMIMEInfo::GetVia (   )  const

PStringList SIPMIMEInfo::GetViaList (   )  const

PString SIPMIMEInfo::GetWWWAuthenticate (   )  const

BOOL SIPMIMEInfo::HasFieldParameter (  const PString &  , const PString &  )

return TRUE if the header field parameter is present

void SIPMIMEInfo::SetAccept (  const PString &  v  )

void SIPMIMEInfo::SetAcceptEncoding (  const PString &  v  )

void SIPMIMEInfo::SetAcceptLanguage (  const PString &  v  )

void SIPMIMEInfo::SetAllow (  const PString &  v  )

void SIPMIMEInfo::SetCallID (  const PString &  v  )

void SIPMIMEInfo::SetContact (  const SIPURL &  url  )

void SIPMIMEInfo::SetContact (  const PString &  v  )

void SIPMIMEInfo::SetContentEncoding (  const PString &  v  )

void SIPMIMEInfo::SetContentLength (  PINDEX  v  )

void SIPMIMEInfo::SetContentType (  const PString &  v  )

void SIPMIMEInfo::SetCSeq (  const PString &  v  )

void SIPMIMEInfo::SetDate (  void   )

void SIPMIMEInfo::SetDate (  const PTime &  t  )

void SIPMIMEInfo::SetDate (  const PString &  v  )

void SIPMIMEInfo::SetEvent (  const PString &  v  )

void SIPMIMEInfo::SetExpires (  unsigned  v  )

void SIPMIMEInfo::SetFieldParameter (  const PString &  , PString &  , const PString &  )

set the value for a header field parameter, replace the current value, or add the parameter and its value if not already present.

void SIPMIMEInfo::SetForm (  BOOL  v  )  [inline]

void SIPMIMEInfo::SetFrom (  const PString &  v  )

void SIPMIMEInfo::SetMaxForwards (  PINDEX  v  )

void SIPMIMEInfo::SetMinExpires (  PINDEX  v  )

void SIPMIMEInfo::SetProxyAuthenticate (  const PString &  v  )

void SIPMIMEInfo::SetRecordRoute (  const PStringList &  v  )

void SIPMIMEInfo::SetReferTo (  const PString &  r  )

void SIPMIMEInfo::SetRoute (  const PStringList &  v  )

void SIPMIMEInfo::SetRouteList (  const char *  name, const PStringList &  v )  [protected]

store string list as one comma-delimited string of route values value formed as "<v[0]>,<v[1]>,<v[2]>" etc

void SIPMIMEInfo::SetSubject (  const PString &  v  )

void SIPMIMEInfo::SetSubscriptionState (  const PString &  v  )

void SIPMIMEInfo::SetSupported (  const PString &  v  )

void SIPMIMEInfo::SetTo (  const PString &  v  )

void SIPMIMEInfo::SetUnsupported (  const PString &  v  )

void SIPMIMEInfo::SetUserAgent (  const SIPEndPoint &  sipep  )

void SIPMIMEInfo::SetVia (  const PString &  v  )

void SIPMIMEInfo::SetViaList (  const PStringList &  v  )

void SIPMIMEInfo::SetWWWAuthenticate (  const PString &  v  )

---

Member Data Documentation

BOOL SIPMIMEInfo::compactForm [protected]

Encode using compact form.

---

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

• sippdu.h

---