Symbian^3 Product 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

Public Member Functions
~CSIPHostPort()
IMPORT_C CSIPHostPort *DecodeL(const TDesC8 &)
IMPORT_C TIntDeletePort()
IMPORT_C TBoolHasPort()
IMPORT_C const TDesC8 &Host()
IMPORT_C TTypeHostType()
IMPORT_C CSIPHostPort *NewL(const CSIPHostPort &)
IMPORT_C CSIPHostPort *NewLC(const CSIPHostPort &)
IMPORT_C TUintPort()
IMPORT_C voidSetHostL(const TDesC8 &)
IMPORT_C voidSetPort(TUint)
HBufC8 *ToTextLC()
IMPORT_C TBooloperator==(const CSIPHostPort &)
Private Member Functions
CSIPHostPort()
voidConstructL()
voidConstructL(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
enumTType { 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()

voidConstructL()[private]

ConstructL(const CSIPHostPort &)

voidConstructL(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 & aValueBNF: host[":"port]

DeletePort()

IMPORT_C TIntDeletePort()
Deletes the port part
Pre-condition
HasPort() == ETrue

HasPort()

IMPORT_C TBoolHasPort()const
Checks if port is present
Pre-condition
HasHost() == ETrue

Host()

IMPORT_C const TDesC8 &Host()const

Gets the host

HostType()

IMPORT_C TTypeHostType()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 & aHostPortCSIPHostPort 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 & aHostPortCSIPHostPort to be copied

ParsePortL(const TDesC8 &)

TUint ParsePortL(const TDesC8 &aValue)[private, static]

Parameters

const TDesC8 & aValue

Port()

IMPORT_C TUintPort()const

Gets the port

SetHostL(const TDesC8 &)

IMPORT_C voidSetHostL(const TDesC8 &aHost)

Sets the host

Parameters

const TDesC8 & aHosthost (host name / IPv4 / IPv6)

SetPort(TUint)

IMPORT_C voidSetPort(TUintaPort)

Sets the port

Parameters

TUint aPortthe port to set

ToTextLC()

HBufC8 *ToTextLC()const

operator==(const CSIPHostPort &)

IMPORT_C TBooloperator==(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]

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.