Collapse all Symbian^3 Application Developer Library

CSIPHostPort Class Reference

class CSIPHostPort : public CBase

Class provides functions for setting and getting host and port in hostport structure (host[":"port]) with syntax checking

sipcodec.lib

Inherits from

CSIPHostPort
- CBase

Public Member Functions
	~CSIPHostPort ()
IMPORT_C CSIPHostPort *	DecodeL (const TDesC8 &)
IMPORT_C TInt	DeletePort ()
IMPORT_C TBool	HasPort ()
IMPORT_C const TDesC8 &	Host ()
IMPORT_C TType	HostType ()
IMPORT_C CSIPHostPort *	NewL (const CSIPHostPort &)
IMPORT_C CSIPHostPort *	NewLC (const CSIPHostPort &)
IMPORT_C TUint	Port ()
IMPORT_C void	SetHostL (const TDesC8 &)
IMPORT_C void	SetPort ( TUint )
HBufC8 *	ToTextLC ()
IMPORT_C TBool	operator== (const CSIPHostPort &)

Private Member Functions
	CSIPHostPort ()
void	ConstructL ()
void	ConstructL (const CSIPHostPort &)
TUint	ParsePortL (const TDesC8 &)

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

Public Member Enumerations
enum	TType { ESIPNoHost = 0, ESIPIpv4 = 1, ESIPIpv6 = 2, ESIPHostName = 3 }

Private Attributes
TBool	iHasPort
HBufC8 *	iHost
TType	iHostType
TUint	iPort

Constructor & Destructor Documentation

CSIPHostPort()

CSIPHostPort

(

)

[private]

~CSIPHostPort()

IMPORT_C

~CSIPHostPort

(

)

Destructor, deletes the resources of CSIPHostPort .

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(const CSIPHostPort &)

void

ConstructL

(

const CSIPHostPort &

aHostPort

)

[private]

Parameters

const CSIPHostPort & aHostPort

DecodeL(const TDesC8 &)

IMPORT_C CSIPHostPort *

DecodeL

(

const TDesC8 &

aValue

)

[static]

Constructs a CSIPHostPort from textual representation

Parameters

const TDesC8 & aValue

BNF: host[":"port]

DeletePort()

IMPORT_C TInt

DeletePort

(

)

Deletes the port part

Pre-condition: HasPort() == ETrue

HasPort()

IMPORT_C TBool

HasPort

(

)

const

Checks if port is present

Pre-condition: HasHost() == ETrue

Host()

IMPORT_C const TDesC8 &

Host

(

)

const

Gets the host

HostType()

IMPORT_C TType

HostType

(

)

const

Gets the type of the host

NewL(const CSIPHostPort &)

IMPORT_C CSIPHostPort *

NewL

(

const CSIPHostPort &

aHostPort

)

[static]

Creates a deep copy of the given CSIPHostPort instance

Parameters

const CSIPHostPort & aHostPort

CSIPHostPort to be copied

NewLC(const CSIPHostPort &)

IMPORT_C CSIPHostPort *

NewLC

(

const CSIPHostPort &

aHostPort

)

[static]

Creates a deep copy of the given CSIPHostPort instance and pushes it to CleanupStack .

Parameters

const CSIPHostPort & aHostPort

CSIPHostPort to be copied

ParsePortL(const TDesC8 &)

TUint

ParsePortL

(

const TDesC8 &

aValue

)

[private, static]

Parameters

const TDesC8 & aValue

Port()

IMPORT_C TUint

Port

(

)

const

Gets the port

SetHostL(const TDesC8 &)

IMPORT_C void

SetHostL

(

const TDesC8 &

aHost

)

Sets the host

Parameters

const TDesC8 & aHost

host (host name / IPv4 / IPv6)

SetPort(TUint)

IMPORT_C void

SetPort

(

TUint

aPort

)

Sets the port

Parameters

TUint aPort

the port to set

ToTextLC()

HBufC8 *

ToTextLC

(

)

const

operator==(const CSIPHostPort &)

IMPORT_C TBool

operator==

(

const CSIPHostPort &

aHostPort

)

const

Compares this object to another instance of CSIPHostPort

Parameters

const CSIPHostPort & aHostPort

Member Enumerations Documentation

Enum TType

SIP host types

Enumerators

ESIPNoHost = 0
ESIPIpv4 = 1
ESIPIpv6 = 2
ESIPHostName = 3

Member Data Documentation

TBool iHasPort

TBool

iHasPort

[private]

HBufC8 * iHost

HBufC8 *

iHost

[private]

TType iHostType

TType

iHostType

[private]

TUint iPort

TUint

iPort

[private]