Represents the "media-type" element in the RFC 3261 grammar. More...

#include <Mime.hxx>

Inheritance diagram for resip::Mime:

Public Member Functions
	Mime ()

	Mime (const Data &type, const Data &subType)

	Mime (const HeaderFieldValue &hfv, Headers::Type type, PoolBase *pool=0)

	Mime (const Mime &orig, PoolBase *pool=0)

Mime &	operator= (const Mime &)

bool	operator< (const Mime &rhs) const

bool	isEqual (const Mime &rhs) const

bool	operator== (const Mime &rhs) const

bool	operator!= (const Mime &rhs) const

const Data &	type () const

const Data &	subType () const

Data &	type ()

Data &	subType ()

virtual void	parse (ParseBuffer &pb)

virtual ParserCategory *	clone () const

virtual ParserCategory *	clone (void *location) const

virtual ParserCategory *	clone (PoolBase *pool) const

virtual EncodeStream &	encodeParsed (EncodeStream &str) const

virtual Parameter *	createParam (ParameterTypes::Type type, ParseBuffer &pb, const std::bitset< 256 > &terminators, PoolBase *pool)

bool	exists (const Param< Mime > &paramType) const

void	remove (const Param< Mime > &paramType)

	defineParam (accessType, "access-type", DataParameter, "RFC 2046")

	defineParam (boundary, "boundary", DataParameter, "RFC 2046")

	defineParam (charset, "charset", DataParameter, "RFC 2045")

	defineParam (directory, "directory", DataParameter, "RFC 2046")

	defineParam (expiration, "expiration", QuotedDataParameter, "RFC 2046")

	defineParam (micalg, "micalg", DataParameter, "RFC 1847")

	defineParam (mode, "mode", DataParameter, "RFC 2046")

	defineParam (name, "name", DataParameter, "RFC 2046")

	defineParam (permission, "permission", DataParameter, "RFC 2046")

	defineParam (protocol, "protocol", QuotedDataParameter, "RFC 1847")

	defineParam (q, "q", QValueParameter, "RFC 3261")

	defineParam (server, "server", DataParameter, "RFC 2046")

	defineParam (site, "site", DataParameter, "RFC 2046")

	defineParam (size, "size", DataParameter, "RFC 2046")

	defineParam (smimeType, "smime-type", DataParameter, "RFC 2633")

	defineParam (url, "url", QuotedDataParameter, "RFC 4483")

bool	exists (const ParamBase &paramType) const
	Checks for the existence of a natively supported parameter.

bool	exists (const ExtensionParameter &param) const
	Checks for the existence of a non-natively-supported parameter.

void	remove (const ParamBase &paramType)
	Removes a natively supported parameter, if the parameter is present.

void	remove (const ExtensionParameter &param)
	Removes a non-natively-supported parameter, if the parameter is present.

const Data &	param (const ExtensionParameter &param) const
	Const accessor for non-natively-supported parameter types.

Data &	param (const ExtensionParameter &param)
	Accessor for non-natively-supported parameter types.

Public Member Functions inherited from resip::ParserCategory
	ParserCategory (const HeaderFieldValue &headerFieldValue, Headers::Type type, PoolBase *pool=0)

	ParserCategory (const char buf, int length, Headers::Type type, PoolBase pool=0)

	ParserCategory (const ParserCategory &rhs, PoolBase *pool=0)

ParserCategory &	operator= (const ParserCategory &rhs)

virtual	~ParserCategory ()

bool	exists (const ParamBase &paramType) const
	Checks for the existence of a natively supported parameter.

void	remove (const ParamBase &paramType)
	Removes a natively supported parameter, if the parameter is present.

const Data &	param (const ExtensionParameter &param) const
	Const accessor for non-natively-supported parameter types.

Data &	param (const ExtensionParameter &param)
	Accessor for non-natively-supported parameter types.

void	remove (const ExtensionParameter &param)
	Removes a non-natively-supported parameter, if the parameter is present.

bool	exists (const ExtensionParameter &param) const
	Checks for the existence of a non-natively-supported parameter.

void	removeParametersExcept (const ParameterTypeSet &set=EmptyParameterTypeSet)
	Removes all known parameters except those that are specified in set.

void	clearUnknownParameters ()

void	parseParameters (ParseBuffer &pb)

EncodeStream &	encodeParameters (EncodeStream &str) const
	Encodes parameters as they should appear on the wire.

Data	commutativeParameterHash () const

Parameter *	getParameterByEnum (ParameterTypes::Type type) const

void	removeParameterByEnum (ParameterTypes::Type type)

void	setParameter (const Parameter *parameter)

int	numKnownParams () const
	Returns the number of known (natively supported) parameters.

int	numUnknownParams () const
	Returns the number of unknown parameters.

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 Attributes
static constexpr CommaHandlingMode	commaHandling = CommasAllowedOutputCommas

Static Public Attributes inherited from resip::ParserCategory
static const ParameterTypeSet	EmptyParameterTypeSet

Additional Inherited Members
Public Types inherited from resip::ParserCategory
enum	{ UnknownParserCategory = -1 }

enum	CommaHandlingMode { NoCommaTokenizing = 0 , CommasAllowedOutputMulti = 1 , CommasAllowedOutputCommas = 3 }

typedef std::set< ParameterTypes::Type >	ParameterTypeSet

Protected Types inherited from resip::ParserCategory
typedef std::vector< Parameter , StlPoolAllocator< Parameter , PoolBase > >	ParameterList

Protected Member Functions inherited from resip::ParserCategory
	ParserCategory (PoolBase *pool=0)

bool	addParameter (Parameter *param)

bool	addParameter (UnknownParameter *unknownParam)

Parameter *	getParameterByData (const Data &data) const

void	removeParameterByData (const Data &data)

PoolBase *	getPool ()

void	freeParameter (Parameter *p)

virtual const Data &	errorContext () const

Protected Member Functions inherited from resip::LazyParser
	LazyParser ()

void	clear ()

Protected Attributes inherited from resip::ParserCategory
ParameterList	mParameters

ParameterList	mUnknownParameters

PoolBase *	mPool

Headers::Type	mHeaderType

Detailed Description

Represents the "media-type" element in the RFC 3261 grammar.

Definition at line 19 of file Mime.hxx.

Constructor & Destructor Documentation

◆ Mime() [1/4]

Mime::Mime ( )

Definition at line 20 of file Mime.cxx.

◆ Mime() [2/4]

Mime::Mime	(	const Data &	type,
		const Data &	subType
	)

Definition at line 26 of file Mime.cxx.

◆ Mime() [3/4]

Mime::Mime	(	const HeaderFieldValue &	hfv,
		Headers::Type	type,
		PoolBase *	pool = `0`
	)

Definition at line 32 of file Mime.cxx.

◆ Mime() [4/4]

Mime::Mime	(	const Mime &	orig,
		PoolBase *	pool = `0`
	)

Definition at line 40 of file Mime.cxx.

Member Function Documentation

◆ clone() [1/3]

ParserCategory * Mime::clone ( ) const

virtual

Implements resip::ParserCategory.

Definition at line 140 of file Mime.cxx.

◆ clone() [2/3]

ParserCategory * Mime::clone ( PoolBase * pool ) const

virtual

Implements resip::ParserCategory.

Definition at line 152 of file Mime.cxx.

◆ clone() [3/3]

ParserCategory * Mime::clone ( void * location ) const

virtual

Implements resip::ParserCategory.

Definition at line 146 of file Mime.cxx.

◆ createParam()

Parameter * Mime::createParam	(	ParameterTypes::Type	type,
		ParseBuffer &	pb,
		const std::bitset< 256 > &	terminators,
		PoolBase *	pool
	)

virtual

Reimplemented from resip::ParserCategory.

Definition at line 168 of file Mime.cxx.

◆ defineParam() [1/16]

resip::Mime::defineParam	(	accessType	,
		"access-type"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [2/16]

resip::Mime::defineParam	(	boundary	,
		"boundary"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [3/16]

resip::Mime::defineParam	(	charset	,
		"charset"	,
		DataParameter	,
		"RFC 2045"
	)

◆ defineParam() [4/16]

resip::Mime::defineParam	(	directory	,
		"directory"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [5/16]

resip::Mime::defineParam	(	expiration	,
		"expiration"	,
		QuotedDataParameter	,
		"RFC 2046"
	)

◆ defineParam() [6/16]

resip::Mime::defineParam	(	micalg	,
		"micalg"	,
		DataParameter	,
		"RFC 1847"
	)

◆ defineParam() [7/16]

resip::Mime::defineParam	(	mode	,
		"mode"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [8/16]

resip::Mime::defineParam	(	name	,
		"name"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [9/16]

resip::Mime::defineParam	(	permission	,
		"permission"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [10/16]

resip::Mime::defineParam	(	protocol	,
		"protocol"	,
		QuotedDataParameter	,
		"RFC 1847"
	)

◆ defineParam() [11/16]

resip::Mime::defineParam	(	q	,
		"q"	,
		QValueParameter	,
		"RFC 3261"
	)

◆ defineParam() [12/16]

resip::Mime::defineParam	(	server	,
		"server"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [13/16]

resip::Mime::defineParam	(	site	,
		"site"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [14/16]

resip::Mime::defineParam	(	size	,
		"size"	,
		DataParameter	,
		"RFC 2046"
	)

◆ defineParam() [15/16]

resip::Mime::defineParam	(	smimeType	,
		"smime-type"	,
		DataParameter	,
		"RFC 2633"
	)

◆ defineParam() [16/16]

resip::Mime::defineParam	(	url	,
		"url"	,
		QuotedDataParameter	,
		"RFC 4483"
	)

◆ encodeParsed()

EncodeStream & Mime::encodeParsed ( EncodeStream & str ) const

virtual

Implements resip::LazyParser.

Definition at line 158 of file Mime.cxx.

◆ exists() [1/3]

bool ParserCategory::exists ( const ExtensionParameter & param ) const

Checks for the existence of a non-natively-supported parameter.

Parameters

param The runtime constructed accessor token.

Returns: true iff the parameter is present.

Definition at line 187 of file ParserCategory.cxx.

◆ exists() [2/3]

bool Mime::exists ( const Param< Mime > & paramType ) const

Definition at line 178 of file Mime.cxx.

◆ exists() [3/3]

bool resip::ParserCategory::exists ( const ParamBase & paramType ) const

inline

Checks for the existence of a natively supported parameter.

Parameters

paramType The accessor token for the parameter.

Returns: true iff the parameter is present.

Definition at line 145 of file ParserCategory.hxx.

◆ isEqual()

bool Mime::isEqual ( const Mime & rhs ) const

Definition at line 74 of file Mime.cxx.

◆ operator!=()

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

Definition at line 88 of file Mime.cxx.

◆ operator<()

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

Definition at line 59 of file Mime.cxx.

◆ operator=()

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

Definition at line 48 of file Mime.cxx.

◆ operator==()

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

Definition at line 81 of file Mime.cxx.

◆ param() [1/2]

Data & ParserCategory::param ( const ExtensionParameter & param )

Accessor for non-natively-supported parameter types.

Will create the parameter if it does not exist.

Parameters

param The runtime constructed parameter accessor.

Returns: The parameter, as a raw Data.

Definition at line 173 of file ParserCategory.cxx.

◆ param() [2/2]

const Data & ParserCategory::param ( const ExtensionParameter & param ) const

Const accessor for non-natively-supported parameter types.

Exceptions

ParserCategory::Exception if this parameter doesn't exist.

Parameters

param The runtime constructed parameter accessor.

Returns: The parameter, as a raw Data.

Definition at line 165 of file ParserCategory.cxx.

◆ parse()

void Mime::parse ( ParseBuffer & pb )

virtual

Implements resip::LazyParser.

Definition at line 120 of file Mime.cxx.

◆ remove() [1/3]

void ParserCategory::remove ( const ExtensionParameter & param )

Removes a non-natively-supported parameter, if the parameter is present.

Parameters

param The accessor token for the parameter.

Definition at line 180 of file ParserCategory.cxx.

◆ remove() [2/3]

void Mime::remove ( const Param< Mime > & paramType )

Definition at line 186 of file Mime.cxx.

◆ remove() [3/3]

void ParserCategory::remove ( const ParamBase & paramType )

Removes a natively supported parameter, if the parameter is present.

Parameters

paramType The accessor token for the parameter.

Definition at line 156 of file ParserCategory.cxx.

◆ subType() [1/2]

Data & Mime::subType ( )

Definition at line 113 of file Mime.cxx.

◆ subType() [2/2]

const Data & Mime::subType ( ) const

Definition at line 100 of file Mime.cxx.

◆ type() [1/2]

Data & Mime::type ( )

Definition at line 107 of file Mime.cxx.

◆ type() [2/2]

const Data & Mime::type ( ) const

Definition at line 94 of file Mime.cxx.

Member Data Documentation

◆ commaHandling

constexpr CommaHandlingMode resip::Mime::commaHandling = CommasAllowedOutputCommas

staticconstexpr

Definition at line 22 of file Mime.hxx.

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

resip/stack/Mime.hxx
resip/stack/Mime.cxx

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Mime() [1/4]

◆ Mime() [2/4]

◆ Mime() [3/4]

◆ Mime() [4/4]

Member Function Documentation

◆ clone() [1/3]

◆ clone() [2/3]

◆ clone() [3/3]

◆ createParam()

◆ defineParam() [1/16]

◆ defineParam() [2/16]

◆ defineParam() [3/16]

◆ defineParam() [4/16]

◆ defineParam() [5/16]

◆ defineParam() [6/16]

◆ defineParam() [7/16]

◆ defineParam() [8/16]

◆ defineParam() [9/16]

◆ defineParam() [10/16]

◆ defineParam() [11/16]

◆ defineParam() [12/16]

◆ defineParam() [13/16]

◆ defineParam() [14/16]

◆ defineParam() [15/16]

◆ defineParam() [16/16]

◆ encodeParsed()

◆ exists() [1/3]

◆ exists() [2/3]

◆ exists() [3/3]

◆ isEqual()

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ param() [1/2]

◆ param() [2/2]

◆ parse()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ subType() [1/2]

◆ subType() [2/2]

◆ type() [1/2]

◆ type() [2/2]

Member Data Documentation

◆ commaHandling