Collapse all Symbian^3 Product Developer Library

CAuthority16 Class Reference

class CAuthority16 : public CBase

Dependencies : CBase, TAuthorityC16. Comments : Provides modifying functionality on the components of an authority object, as defined in RFC2396. There are 3 components; userinfo, host and port.

The object holds parsed authority information. It is owning. It uses 16-bit descriptors.

The functionality provided by this API allows the authority components to be set or removed from this parsed authority. Also, it provides a reference to TAuthorityC16 object so that the non-modifying functionality can be used. Deprecated in 9.1

Since: 6.0

Inherits from

CAuthority16
- CBase

Public Member Functions
	~CAuthority16()
IMPORT_C const TAuthorityC16 &	Authority()
IMPORT_C CAuthority16 *	NewL(const TAuthorityC16 &)
IMPORT_C CAuthority16 *	NewL()
IMPORT_C CAuthority16 *	NewLC(const TAuthorityC16 &)
IMPORT_C CAuthority16 *	NewLC()
IMPORT_C void	RemoveComponentL(TAuthorityComponent)
IMPORT_C void	SetAndEscapeComponentL(const TDesC16 &, TAuthorityComponent)
IMPORT_C void	SetComponentL(const TDesC16 &, TAuthorityComponent)

Private Member Functions
	CAuthority16(const TAuthorityC16 &)
void	ConstructL()
void	FormAuthorityL()

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
TAuthorityC16	iAuthority
HBufC16 *	iAuthorityBuf

Constructor & Destructor Documentation

CAuthority16(const TAuthorityC16 &)

CAuthority16

(

const TAuthorityC16 &

aAuthority

)

[private]

Constructor. First phase of two-phase construction method. Does non-allocating construction.

Since: 6.0

Parameters

const TAuthorityC16 & aAuthority

The parsed authority component information from which to create the authority.

~CAuthority16()

IMPORT_C

~CAuthority16

(

)

Destructor.

Since: 6.0

Deprecated in 9.1

Member Functions Documentation

Authority()

IMPORT_C const TAuthorityC16 &

Authority

(

)

const

Provides a reference to the parsed authority. Allows access to the non-modifying API for TAuthorityC.

Since: 6.0

Deprecated in 9.1

ConstructL()

void

ConstructL

(

)

[private]

Second phase of two-phase construction method. Does any allocations required to fully construct the object.

Since: 6.0

Pre-condition: First phase of construction is complete.

Post-condition: The object is fully constructed and initialized.

FormAuthorityL()

void

FormAuthorityL

(

)

[private]

Forms the authority from the parsed authority information. A copy of the parsed authority is created. The parsed authority is changed to refer to the copy.

Since: 6.0

Pre-condition: The parsed authority information is set.

Post-condition: The authority buffer is a copy of the parsed authority, and the parsed authority now refers to the copy.

NewL(const TAuthorityC16 &)

IMPORT_C CAuthority16 *

NewL

(

const TAuthorityC16 &

aAuthority

)

[static]

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates an authority object which is a copy of the input parameter aAuthority.

Since: 6.0

Deprecated in 9.1

Post-condition: A fully constructed and initialized CAuthority16 object.

Parameters

const TAuthorityC16 & aAuthority

A reference to a parsed authority object.

NewL()

IMPORT_C CAuthority16 *

NewL

(

)

[static]

Static factory constructor. Uses two phase construction and leaves nothing on the CleanupStack. Creates an authority object which is empty.

Since: 6.0

Deprecated in 9.1

Post-condition: A fully constructed and initialized CAuthority16 object.

NewLC(const TAuthorityC16 &)

IMPORT_C CAuthority16 *

NewLC

(

const TAuthorityC16 &

aAuthority

)

[static]

Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates an authority object which is a copy of the input parameter aAuthority.

Since: 6.0

Deprecated in 9.1

Post-condition: A fully constructed and initialized CAuthority16 object.

Parameters

const TAuthorityC16 & aAuthority

A reference to a parsed authority object.

NewLC()

IMPORT_C CAuthority16 *

NewLC

(

)

[static]

Static factory constructor. Uses two phase construction and leaves a pointer to created object on the CleanupStack. Creates an authority object which is empty.

Since: 6.0

Deprecated in 9.1

Post-condition: A fully constructed and initialized CAuthority16 object.

RemoveComponentL(TAuthorityComponent)

IMPORT_C void

RemoveComponentL

(

TAuthorityComponent

aComponent

)

Removes the specified component from the authority. If the component does not exist then this function does nothing.

Since: 6.0

Deprecated in 9.1

Pre-condition: Object is fully constructed.

Post-condition: The authority is updated to exclude the specified component.

Parameters

TAuthorityComponent aComponent

An enum specifying the component to be removed.

SetAndEscapeComponentL(const TDesC16 &, TAuthorityComponent)

IMPORT_C void	SetAndEscapeComponentL	(	const TDesC16 &	aData,
			TAuthorityComponent	aComponent
		)

Escape encodes the component then sets the specified component in the authority. The component is set to the value given in the argument aData. If the specified component already exists then it is replaced with the new value.

Since: 6.0

Deprecated in 9.1

Pre-condition: Object is fully constructed.

Post-condition: The authority has the specified component set to the new value.

Parameters

const TDesC16 & aData	A descriptor pointer to the new value for the authority component.
TAuthorityComponent aComponent	An enum specifying the component to be set.

SetComponentL(const TDesC16 &, TAuthorityComponent)

IMPORT_C void	SetComponentL	(	const TDesC16 &	aData,
			TAuthorityComponent	aComponent
		)

Sets the specified component in the authority. The component is set to the value given in the argument aData. If the specified component already exists then it is replaced with the new value.

Since: 6.0

Deprecated in 9.1

Pre-condition: Object is fully constructed.

Post-condition: The authority has the specified component set to the new value. KErrArgument If aComponent goes out of range.

Parameters

const TDesC16 & aData	A descriptor pointer to the new value for the authority component.
TAuthorityComponent aComponent	An enum specifying the component to be set.

Member Data Documentation

TAuthorityC16 iAuthority

TAuthorityC16

iAuthority

[private]

The parsed authority object.

HBufC16 * iAuthorityBuf

HBufC16 *

iAuthorityBuf

[private]

The descriptor buffer that contains the authority.