S60 3rd Edition API Reference: CSIPParameterHeaderBase Class Reference

CSIPParameterHeaderBase Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipparameterheaderbase.h>

Inherits CSIPHeaderBase.

Inherited by CSIPAcceptContactHeader, CSIPAcceptEncodingHeader, CSIPAcceptHeader, CSIPAcceptLanguageHeader, CSIPAddressHeaderBase, CSIPContactHeader, CSIPContentDispositionHeader, CSIPContentTypeHeader, CSIPEventHeader, CSIPFromToHeaderBase, CSIPRetryAfterHeader, CSIPRouteHeaderBase, CSIPSecurityHeaderBase, and CSIPSubscriptionStateHeader.

Detailed Description

PublishedAll
Released
A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

This is an abstract class and cannot be instantiated.


Public Member Functions

virtual IMPORT_C ~CSIPParameterHeaderBase ()
 Destructor, deletes the resources of CSIPParameterHeaderBase.
IMPORT_C TBool HasParam (RStringF aName) const
 Checks if a parameter is present.
IMPORT_C RStringF ParamValue (RStringF aName) const
 Gets a parameter value.
IMPORT_C void SetParamL (RStringF aName, RStringF aValue)
 Sets a parameter with a value.
IMPORT_C void SetParamL (RStringF aName)
 Sets a parameter without a value Takes copy of the name, so if the RStringF has been dynamically allocated, it can be closed if necessary after the function returns.
IMPORT_C void DeleteParam (RStringF aName)
 Deletes a parameter.
IMPORT_C TInt ParamCount () const
 Gets the count of header parameters.
IMPORT_C TInt Param (TInt aIndex, RStringF &aName) const
 Gets a header parameter name by index.
IMPORT_C HBufC8 * ToTextValueL () const
 From CSIPHeaderBase ToTextValueL.

Protected Member Functions

 CSIPParameterHeaderBase (const TChar &aSeparator)
void ParseL (const TDesC8 &aValue, TBool aIgnoreParenthesis=ETrue)
virtual TBool ParamInsertionAllowed () const
virtual HBufC8 * ToTextMandatoryPartLC () const =0
virtual void ParseMandatoryPartL (const TDesC8 &aMandatoryPart)=0
virtual const CSIPParamContainerBase & Params () const =0
virtual CSIPParamContainerBase & Params ()=0

Constructor & Destructor Documentation

virtual IMPORT_C CSIPParameterHeaderBase::~CSIPParameterHeaderBase (   )  [virtual]
 

Destructor, deletes the resources of CSIPParameterHeaderBase.

CSIPParameterHeaderBase::CSIPParameterHeaderBase ( const TChar &  aSeparator  )  [protected]
 

Member Function Documentation

IMPORT_C void CSIPParameterHeaderBase::DeleteParam ( RStringF  aName  ) 
 

Deletes a parameter.

Parameters:
aName the parameter name to delete
IMPORT_C TBool CSIPParameterHeaderBase::HasParam ( RStringF  aName  )  const
 

Checks if a parameter is present.

Parameters:
aName the name of the parameter
Returns:
ETrue if present, otherwise EFalse
IMPORT_C TInt CSIPParameterHeaderBase::Param ( TInt  aIndex,
RStringF &  aName
)  const
 

Gets a header parameter name by index.

This function can be used when looping through all the header parameters.

Parameters:
aIndex the index of the parameter
aName copy of the parameter name that must be closed by the caller.
Returns:
KErrNotFound if aIndex is invalid. Otherwise EFalse.
IMPORT_C TInt CSIPParameterHeaderBase::ParamCount (   )  const
 

Gets the count of header parameters.

Returns:
count of header parameters
virtual TBool CSIPParameterHeaderBase::ParamInsertionAllowed (   )  const [protected, virtual]
 
virtual CSIPParamContainerBase& CSIPParameterHeaderBase::Params (   )  [protected, pure virtual]
 
virtual const CSIPParamContainerBase& CSIPParameterHeaderBase::Params (   )  const [protected, pure virtual]
 
IMPORT_C RStringF CSIPParameterHeaderBase::ParamValue ( RStringF  aName  )  const
 

Gets a parameter value.

Precondition:
HasParam(aName) == ETrue
Parameters:
aName the name of the parameter
Returns:
the parameter value if present, otherwise a zero-length length value.
void CSIPParameterHeaderBase::ParseL ( const TDesC8 &  aValue,
TBool  aIgnoreParenthesis = ETrue
)  [protected]
 
virtual void CSIPParameterHeaderBase::ParseMandatoryPartL ( const TDesC8 &  aMandatoryPart  )  [protected, pure virtual]
 
IMPORT_C void CSIPParameterHeaderBase::SetParamL ( RStringF  aName  ) 
 

Sets a parameter without a value Takes copy of the name, so if the RStringF has been dynamically allocated, it can be closed if necessary after the function returns.

Precondition:
HasParam(aName) == EFalse
Parameters:
aName the parameter name to set
IMPORT_C void CSIPParameterHeaderBase::SetParamL ( RStringF  aName,
RStringF  aValue
) 
 

Sets a parameter with a value.

Takes copies of the name and value, so if the RStringFs have been dynamically allocated, they can be closed if necessary after the function returns.

Precondition:
HasParam(aName) == EFalse
Parameters:
aName the name of the parameter
aValue the parameter value to set
virtual HBufC8* CSIPParameterHeaderBase::ToTextMandatoryPartLC (   )  const [protected, pure virtual]
 
IMPORT_C HBufC8* CSIPParameterHeaderBase::ToTextValueL (   )  const [virtual]
 

From CSIPHeaderBase ToTextValueL.

Implements CSIPHeaderBase.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top