Collapse all Symbian^3 Application Developer Library

CSIPResponse Class Reference

class CSIPResponse : public CSIPMessage

Class provides functions for manipulating a SIP response and the reason phrase.

sipcodec.lib

Inherits from

CSIPResponse
- CSIPMessage
  - CBase

Public Member Functions
	~CSIPResponse ()
IMPORT_C TBool	IsErrorResponse ()
IMPORT_C TBool	IsRequest ()
IMPORT_C CSIPResponse *	NewL ( TUint , RStringF )
CSIPResponse *	NewL ()
IMPORT_C CSIPResponse *	NewLC ( TUint , RStringF )
CSIPResponse *	NewLC ()
IMPORT_C RStringF	ReasonPhrase ()
IMPORT_C TUint	ResponseCode ()
IMPORT_C void	SetReasonPhraseL ( RStringF )
void	SetReasonPhraseL (const TDesC8 &)
IMPORT_C void	SetResponseCodeL ( TUint )
IMPORT_C TType	Type ()

Private Member Functions
	CSIPResponse ()
void	ConstructL ()
void	ConstructL ( TUint , RStringF )
HBufC8 *	ToTextFirstLineLC ()

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()
	CSIPMessage::AddHeaderL(CSIPHeaderBase *)
	CSIPMessage::AddHeaderL(const CSIPHeaderBase &)
	CSIPMessage::AllHeadersL()
	CSIPMessage::AnnouncedContentLength()const
	CSIPMessage::CSIPMessage()
	CSIPMessage::CSeq()
	CSIPMessage::CallID()
	CSIPMessage::Content()const
	CSIPMessage::DeleteHeaders(RStringF)
	CSIPMessage::EncodedHeaderPartLengthL()
	CSIPMessage::ExternalizeHeadersL(RWriteStream &)
	CSIPMessage::From()
	CSIPMessage::HasAnnouncedContentLength()const
	CSIPMessage::HasHeader(RStringF)const
	CSIPMessage::Header(RStringF,TInt)
	CSIPMessage::HeaderCount(RStringF)
	CSIPMessage::Headers(RStringF)
	CSIPMessage::InternalizeHeadersL(RReadStream &)
	CSIPMessage::RemoveHeader(const CSIPHeaderBase *)
	CSIPMessage::ReplaceHeaderL(CSIPHeaderBase ,CSIPHeaderBase )
	CSIPMessage::ReplaceHeadersL(RPointerArray< CSIPHeaderBase > &)
	CSIPMessage::SIPVersion()const
	CSIPMessage::SetContent(HBufC8 *)
	CSIPMessage::SetSIPVersionL(const TDesC8 &)
	CSIPMessage::TakeContentOwnershipL()
	CSIPMessage::To()
	CSIPMessage::ToTextHeaderPartL()
	CSIPMessage::ToTextHeaderPartLC()
	CSIPMessage::ToTextL()
	CSIPMessage::ToTextLC()
	CSIPMessage::~CSIPMessage()

Public Member Enumerations
enum	TType { E1XX = 1, E2XX , E3XX , E4XX , E5XX , E6XX }

Private Attributes
RStringF	iReasonPhrase
TUint	iResponseCode

Constructor & Destructor Documentation

CSIPResponse()

CSIPResponse

(

)

[private]

~CSIPResponse()

IMPORT_C

~CSIPResponse

(

)

Destructor

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(TUint, RStringF)

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

Parameters

TUint aResponseCode
RStringF aReasonPhrase

IsErrorResponse()

IMPORT_C TBool

IsErrorResponse

(

)

const

Checks if the response is an error response (>=300)

IsRequest()

IMPORT_C TBool

IsRequest

(

)

const [virtual]

From CSIPMessage IsRequest

NewL(TUint, RStringF)

IMPORT_C CSIPResponse *	NewL	(	TUint	aResponseCode,
			RStringF	aReasonPhrase
		)	[static]

Creates a new instance of CSIPResponse

Pre-condition: (aResponseCode >= 100 && aResponseCode < 700)

Parameters

TUint aResponseCode	a response code
RStringF aReasonPhrase	a textual description of the response reason

NewL()

CSIPResponse *

NewL

(

)

[static]

NewLC(TUint, RStringF)

IMPORT_C CSIPResponse *	NewLC	(	TUint	aResponseCode,
			RStringF	aReasonPhrase
		)	[static]

Creates a new instance of CSIPResponse and pushes it to CleanupStack

Pre-condition: (aResponseCode >= 100 && aResponseCode < 700)

Parameters

TUint aResponseCode	a response code
RStringF aReasonPhrase	a textual description of the response reason

NewLC()

CSIPResponse *

NewLC

(

)

[static]

ReasonPhrase()

IMPORT_C RStringF

ReasonPhrase

(

)

const

Gets the SIP reason phrase

ResponseCode()

IMPORT_C TUint

ResponseCode

(

)

const

Gets the SIP response code

SetReasonPhraseL(RStringF)

IMPORT_C void

SetReasonPhraseL

(

RStringF

aReasonPhrase

)

Sets the SIP reason phrase

Parameters

RStringF aReasonPhrase

a reason phrase

SetReasonPhraseL(const TDesC8 &)

void

SetReasonPhraseL

(

const TDesC8 &

aReasonPhrase

)

Parameters

const TDesC8 & aReasonPhrase

SetResponseCodeL(TUint)

IMPORT_C void

SetResponseCodeL

(

TUint

aResponseCode

)

Sets the SIP response code

Pre-condition: (aResponseCode >= 100 && aResponseCode < 700)

Parameters

TUint aResponseCode

a response code

ToTextFirstLineLC()

HBufC8 *

ToTextFirstLineLC

(

)

const [private, virtual]

Type()

IMPORT_C TType

Type

(

)

const

Gets the SIP response class of the response

Member Enumerations Documentation

Enum TType

Response classes

Enumerators

E1XX = 1
E2XX
E3XX
E4XX
E5XX
E6XX

Member Data Documentation

RStringF iReasonPhrase

RStringF

iReasonPhrase

[private]

TUint iResponseCode

TUint

iResponseCode

[private]