S60 3rd Edition API Reference: CSIPRequestElements Class Reference

CSIPRequestElements Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <siprequestelements.h>

Detailed Description

PublishedAll
Released
Class provides functions for creation and manipulation of originator's and recipient's addresses in a SIP request. It also provide functions for manipulation of SIP method for unknown SIP requests.

Public Member Functions

IMPORT_C ~CSIPRequestElements ()
 Destructor.
IMPORT_C void SetToHeaderL (CSIPToHeader *aTo)
 Sets/resets the recipient's To-header To-header must not contain tag-parameter.
IMPORT_C const CSIPToHeader * ToHeader () const
 Gets the recipient's To-header.
IMPORT_C void SetFromHeaderL (CSIPFromHeader *aFrom)
 Sets/resets the originator's From-header.
IMPORT_C const CSIPFromHeader * FromHeader () const
 Gets the originator's From-header.
IMPORT_C const CSIPCSeqHeader * CSeqHeader () const
 Gets CSeq-header.
IMPORT_C void SetRemoteUriL (CUri8 *aRemoteUri)
 Sets the remote URI.
IMPORT_C const CUri8 & RemoteUri () const
 Gets the remote target URI.
IMPORT_C void SetMethodL (RStringF aMethod)
 Sets the SIP request method.
IMPORT_C RStringF Method () const
 Gets the SIP Method for a request.
IMPORT_C const CSIPMessageElements & MessageElements () const
 Gets message elements (contains all SIP user headers and content).
IMPORT_C CSIPMessageElements & MessageElements ()
 Gets message elements (contains all SIP user headers and content) The response elements can be populated with SIP user headers and content using returned reference to the message elements.
void ExternalizeL (RWriteStream &aWriteStream) const

Static Public Member Functions

static IMPORT_C CSIPRequestElements * NewL (CUri8 *aRemoteUri)
 Two-phased constructor.
static IMPORT_C CSIPRequestElements * NewLC (CUri8 *aRemoteUri)
 Two-phased constructor.
static CSIPRequestElements * InternalizeL (RReadStream &aReadStream)

Constructor & Destructor Documentation

IMPORT_C CSIPRequestElements::~CSIPRequestElements (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C const CSIPCSeqHeader* CSIPRequestElements::CSeqHeader (   )  const
 

Gets CSeq-header.

Available for only incoming requests.

Returns:
a CSeq-header or a 0-pointer if not present. Ownership is not transferred.
void CSIPRequestElements::ExternalizeL ( RWriteStream &  aWriteStream  )  const
 
IMPORT_C const CSIPFromHeader* CSIPRequestElements::FromHeader (   )  const
 

Gets the originator's From-header.

Returns:
From-header or a 0-pointer if not present. Ownership is not transferred.
static CSIPRequestElements* CSIPRequestElements::InternalizeL ( RReadStream &  aReadStream  )  [static]
 
IMPORT_C CSIPMessageElements& CSIPRequestElements::MessageElements (   ) 
 

Gets message elements (contains all SIP user headers and content) The response elements can be populated with SIP user headers and content using returned reference to the message elements.

Returns:
message elements
IMPORT_C const CSIPMessageElements& CSIPRequestElements::MessageElements (   )  const
 

Gets message elements (contains all SIP user headers and content).

Returns:
message elements
IMPORT_C RStringF CSIPRequestElements::Method (   )  const
 

Gets the SIP Method for a request.

Returns:
a SIP method name or a an empty string if the method is not defined
static IMPORT_C CSIPRequestElements* CSIPRequestElements::NewL ( CUri8 *  aRemoteUri  )  [static]
 

Two-phased constructor.

If the URI is SIP URI, no SIP URI headers are allowed.

Precondition:
aRemoteURi != 0
Parameters:
aRemoteUri Remote target URI that identifies a resource that the request is addressed to. The ownership is transferred.
static IMPORT_C CSIPRequestElements* CSIPRequestElements::NewLC ( CUri8 *  aRemoteUri  )  [static]
 

Two-phased constructor.

If the URI is SIP URI, no SIP URI headers are allowed.

Precondition:
aRemoteURi != 0
Parameters:
aRemoteUri Remote target URI that identifies a resource that the request is addressed to. The ownership is transferred.
IMPORT_C const CUri8& CSIPRequestElements::RemoteUri (   )  const
 

Gets the remote target URI.

Returns:
remote target URI
IMPORT_C void CSIPRequestElements::SetFromHeaderL ( CSIPFromHeader *  aFrom  ) 
 

Sets/resets the originator's From-header.

From-header must not contain tag-parameter.

Precondition:
aFrom != 0
Parameters:
aFrom a From-header to be set, the ownership is transferred.
Leave:
KErrArgument if aFrom == 0
IMPORT_C void CSIPRequestElements::SetMethodL ( RStringF  aMethod  ) 
 

Sets the SIP request method.

Parameters:
aMethod a SIP method name.
Leave:
KErrArgument if method name given is syntactically incorrect
IMPORT_C void CSIPRequestElements::SetRemoteUriL ( CUri8 *  aRemoteUri  ) 
 

Sets the remote URI.

If the URI is a SIP URI, no SIP URI headers are allowed.

Precondition:
aRemoteUri != 0
Parameters:
aRemoteUri 
Leave:
KErrArgument if aRemoteUri==0
IMPORT_C void CSIPRequestElements::SetToHeaderL ( CSIPToHeader *  aTo  ) 
 

Sets/resets the recipient's To-header To-header must not contain tag-parameter.

Precondition:
aTo != 0
Parameters:
aTo a To-header to be set, the ownership is transferred.
IMPORT_C const CSIPToHeader* CSIPRequestElements::ToHeader (   )  const
 

Gets the recipient's To-header.

Returns:
To-header or a 0-pointer if not present. Ownership is not transferred.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top