S60 3rd Edition API Reference: CSIPSecurityHeaderBase Class Reference

CSIPSecurityHeaderBase Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None


#include <sipsecurityheaderbase.h>

Inherits CSIPParameterHeaderBase.

Inherited by CSIPSecurityClientHeader.


Detailed Description

PublishedAll
Released
A base class for Security-Client, Security-Server and Security-Verify.

Public Member Functions

virtual IMPORT_C ~CSIPSecurityHeaderBase ()
 Destructor, deletes the resources of CSIPSecurityHeaderBase.
IMPORT_C TReal PreferenceParam () const
 Gets the value of "q"-parameter.
IMPORT_C void SetPreferenceParamL (TReal aPreferenceValue)
 Sets the "q"-parameter value.
IMPORT_C const TDesC8 & MechanismName () const
 Gets the Mechanism-Name from the Security header.
IMPORT_C void SetMechanismNameL (const TDesC8 &aMechanismName)
 Sets the Mechanism-Name in the Security header.
TBool MoreThanOneAllowed () const
TPreferredPlace PreferredPlaceInMessage () const

Protected Member Functions

 CSIPSecurityHeaderBase ()
void ConstructL ()
void ConstructL (const TDesC8 &aMechanismName)
void ConstructL (const CSIPSecurityHeaderBase &aSecurityHeaderBase)
void DoInternalizeValueL (RReadStream &aReadStream)

Constructor & Destructor Documentation

virtual IMPORT_C CSIPSecurityHeaderBase::~CSIPSecurityHeaderBase  )  [virtual]
 

Destructor, deletes the resources of CSIPSecurityHeaderBase.

CSIPSecurityHeaderBase::CSIPSecurityHeaderBase  )  [protected]
 

Member Function Documentation

void CSIPSecurityHeaderBase::ConstructL const CSIPSecurityHeaderBase aSecurityHeaderBase  )  [protected]
 
void CSIPSecurityHeaderBase::ConstructL const TDesC8 &  aMechanismName  )  [protected]
 
void CSIPSecurityHeaderBase::ConstructL  )  [protected]
 
void CSIPSecurityHeaderBase::DoInternalizeValueL RReadStream &  aReadStream  )  [protected]
 
IMPORT_C const TDesC8& CSIPSecurityHeaderBase::MechanismName  )  const
 

Gets the Mechanism-Name from the Security header.

Returns:
a Mechanism-Name
TBool CSIPSecurityHeaderBase::MoreThanOneAllowed  )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C TReal CSIPSecurityHeaderBase::PreferenceParam  )  const
 

Gets the value of "q"-parameter.

Returns:
the "q"-parameter value, zero if not present
TPreferredPlace CSIPSecurityHeaderBase::PreferredPlaceInMessage  )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C void CSIPSecurityHeaderBase::SetMechanismNameL const TDesC8 &  aMechanismName  ) 
 

Sets the Mechanism-Name in the Security header.

Parameters:
aMechanismName a Mechanism-Name
IMPORT_C void CSIPSecurityHeaderBase::SetPreferenceParamL TReal  aPreferenceValue  ) 
 

Sets the "q"-parameter value.

Parameters:
aPreferenceValue a "q"-parameter value to set

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

Copyright © Nokia Corporation 2001-2007
Back to top