Symbian^3 Application Developer Library >

CSIPResponseElements Class Reference

class CSIPResponseElements : public CBase

Class provides services for creating and manipulating SIP responses This class is used for creating and manipulating SIP responses including status code, reason phrase and optional elements such user headers, content and its type.

sipclient.lib

Inherits from

Public Member Functions
~CSIPResponseElements ()
IMPORT_C const CSIPCSeqHeader * CSeqHeader ()
void ExternalizeL ( RWriteStream &)
IMPORT_C const CSIPFromHeader * FromHeader ()
CSIPResponseElements * InternalizeL ( RReadStream &)
CSIPResponseElements * InternalizeLC ( RReadStream &)
IMPORT_C const CSIPMessageElements & MessageElements ()
IMPORT_C CSIPMessageElements & MessageElements ()
IMPORT_C CSIPResponseElements * NewL ( TUint , RStringF )
IMPORT_C CSIPResponseElements * NewLC ( TUint , RStringF )
IMPORT_C RStringF ReasonPhrase ()
IMPORT_C void SetReasonPhraseL ( RStringF )
IMPORT_C void SetStatusCodeL ( TUint )
IMPORT_C TUint StatusCode ()
IMPORT_C const CSIPToHeader * ToHeader ()
Private Member Functions
CSIPResponseElements ()
void ConstructL ( TUint , RStringF )
void DoInternalizeL ( RReadStream &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CSIPMessageElements * iMessageElements
RStringF iReasonPhrase
TUint iStatusCode

Constructor & Destructor Documentation

CSIPResponseElements()

CSIPResponseElements ( ) [private]

~CSIPResponseElements()

IMPORT_C ~CSIPResponseElements ( )

Destructor.

Member Functions Documentation

CSeqHeader()

IMPORT_C const CSIPCSeqHeader * CSeqHeader ( ) const

Gets CSeq-header

ConstructL(TUint, RStringF)

void ConstructL ( TUint aStatusCode,
RStringF aReasonPhrase
) [private]

Parameters

TUint aStatusCode
RStringF aReasonPhrase

DoInternalizeL(RReadStream &)

void DoInternalizeL ( RReadStream & aReadStream ) [private]

Parameters

RReadStream & aReadStream

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aWriteStream ) const

Parameters

RWriteStream & aWriteStream

FromHeader()

IMPORT_C const CSIPFromHeader * FromHeader ( ) const

Gets the originator's From-header

InternalizeL(RReadStream &)

CSIPResponseElements * InternalizeL ( RReadStream & aReadStream ) [static]

Parameters

RReadStream & aReadStream

InternalizeLC(RReadStream &)

CSIPResponseElements * InternalizeLC ( RReadStream & aReadStream ) [static]

Parameters

RReadStream & aReadStream

MessageElements()

IMPORT_C const CSIPMessageElements & MessageElements ( ) const

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

MessageElements()

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.

NewL(TUint, RStringF)

IMPORT_C CSIPResponseElements * NewL ( TUint aStatusCode,
RStringF aReasonPhrase
) [static]
Two-phased constructor.
Pre-condition
aStatusCode > 100 && aStatusCode < 700

Parameters

TUint aStatusCode a known SIP response status code. Cannot be 100.
RStringF aReasonPhrase a SIP response reason phrase.

NewLC(TUint, RStringF)

IMPORT_C CSIPResponseElements * NewLC ( TUint aStatusCode,
RStringF aReasonPhrase
) [static]
Two-phased constructor.
Pre-condition
aStatusCode > 100 && aStatusCode < 700

Parameters

TUint aStatusCode a known SIP response status code. Cannot be 100.
RStringF aReasonPhrase a SIP response reason phrase.

ReasonPhrase()

IMPORT_C RStringF ReasonPhrase ( ) const

Gets a SIP Response Reason Phrase.

SetReasonPhraseL(RStringF)

IMPORT_C void SetReasonPhraseL ( RStringF aReasonPhrase )

Sets a SIP Response Reason Phrase.

Parameters

RStringF aReasonPhrase a SIP response reason phrase.

SetStatusCodeL(TUint)

IMPORT_C void SetStatusCodeL ( TUint aStatusCode )
Sets a SIP Response extension status code. It is not possible to set value 100.
Pre-condition
aStatusCode > 100 && aStatusCode < 700
leave
KErrArgument if aStatusCode < 100 or aStatusCode >= 700

Parameters

TUint aStatusCode extension status code

StatusCode()

IMPORT_C TUint StatusCode ( ) const

Gets the SIP Response status code

ToHeader()

IMPORT_C const CSIPToHeader * ToHeader ( ) const

Gets the recipient's To-header

Member Data Documentation

CSIPMessageElements * iMessageElements

CSIPMessageElements * iMessageElements [private]

RStringF iReasonPhrase

RStringF iReasonPhrase [private]

TUint iStatusCode

TUint iStatusCode [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.