CSIPResponseElements Class Reference

#include <mw/sipresponseelements.h>

Link against: sipclient.lib

class CSIPResponseElements : public CBase

Inherits from

CSIPResponseElements
- CBase

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()

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()

Detailed Description

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.

Constructor & Destructor Documentation

~CSIPResponseElements ( )

IMPORT_C

~CSIPResponseElements

(

)

Destructor.

Member Function Documentation

CSeqHeader ( )

IMPORT_C const CSIPCSeqHeader *

CSeqHeader

(

)

const

Gets CSeq-header

Return Value: a CSeq-header or a 0-pointer if not present. Ownership is not transferred.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const

FromHeader ( )

IMPORT_C const CSIPFromHeader *

FromHeader

(

)

const

Gets the originator's From-header

Return Value: a From-header or a 0-pointer if not present. Ownership is not transferred.

InternalizeL ( RReadStream & )

CSIPResponseElements *

InternalizeL

(

RReadStream &

aReadStream

)

[static]

InternalizeLC ( RReadStream & )

CSIPResponseElements *

InternalizeLC

(

RReadStream &

aReadStream

)

[static]

MessageElements ( )

IMPORT_C const CSIPMessageElements &

MessageElements

(

)

const

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

Return Value: message elements

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.

Return Value: message elements

NewL ( TUint, RStringF )

IMPORT_C CSIPResponseElements *	NewL	(	TUint	aStatusCode,
			RStringF	aReasonPhrase
		)	[static]

Two-phased constructor.

Pre-condition: aStatusCode > 100 && aStatusCode < 700

Parameters
aStatusCode	a known SIP response status code. Cannot be 100.
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
aStatusCode	a known SIP response status code. Cannot be 100.
aReasonPhrase	a SIP response reason phrase.

ReasonPhrase ( )

IMPORT_C RStringF

ReasonPhrase

(

)

const

Gets a SIP Response Reason Phrase.

Return Value: a SIP response reason phrase or an empty string if the reason phrase is not defined.

SetReasonPhraseL ( RStringF )

IMPORT_C void

SetReasonPhraseL

(

RStringF

aReasonPhrase

)

Sets a SIP Response Reason Phrase.

Parameters
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

Parameters
aStatusCode	extension status code

Leave Codes
KErrArgument	if aStatusCode < 100 or aStatusCode >= 700

StatusCode ( )

IMPORT_C TUint

StatusCode

(

)

const

Gets the SIP Response status code

Return Value: SIP Response status code

ToHeader ( )

IMPORT_C const CSIPToHeader *

ToHeader

(

)

const

Gets the recipient's To-header

Return Value: a To-header or a 0-pointer if not present. Ownership is not transferred.