Class CAuthority8

class CAuthority8 : public CBase;

Description

Dependencies : CBase, TAuthorityC8. 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 8-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 TAuthorityC8 object so that the non-modifying functionality can be used.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CAuthority8 - Dependencies : CBase, TAuthorityC8

Members

Defined in CAuthority8:
Authority(), NewL(), NewL(), NewLC(), NewLC(), RemoveComponentL(), SetAndEscapeComponentL(), SetComponentL(), ~CAuthority8()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CAuthority8 *NewL(const TAuthorityC8 &aAuthority);

Description

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.

Post-Condition

A fully constructed and initialized CAuthority8 object.

Parameters

const TAuthorityC8 &aAuthority A reference to a parsed authority object.

Return value

CAuthority8 * A pointer to the newly created CAuthority8 object.

static IMPORT_C CAuthority8 *NewLC(const TAuthorityC8 &aAuthority);

Description

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.

Post-Condition

A fully constructed and initialized CAuthority8 object.

Parameters

const TAuthorityC8 &aAuthority A reference to a parsed authority object.

Return value

CAuthority8 * A pointer to the newly created CAuthority8 object.

static IMPORT_C CAuthority8 *NewL();

Description

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

Post-Condition

A fully constructed and initialized CAuthority8 object.

Return value

CAuthority8 * A pointer to the newly created CAuthority8 object.

static IMPORT_C CAuthority8 *NewLC();

Description

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

Post-Condition

A fully constructed and initialized CAuthority8 object.

Return value

CAuthority8 * A pointer to the newly created CAuthority8 object.

IMPORT_C ~CAuthority8();

Description

Destructor.

IMPORT_C const TAuthorityC8 &Authority() const;

Description

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

Return value

const TAuthorityC8 & A const reference to the parsed authority object.

IMPORT_C void SetComponentL(const TDesC8 &aData, TAuthorityComponent aComponent);

Pre-Condition

Object is fully constructed.

Description

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.

Post-Condition

The authority has the specified component set to the new value.

Parameters

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

IMPORT_C void SetAndEscapeComponentL(const TDesC8 &aData, TAuthorityComponent aComponent);

Pre-Condition

Object is fully constructed.

Description

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.

Post-Condition

The authority has the specified component set to the new value.

Parameters

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

IMPORT_C void RemoveComponentL(TAuthorityComponent aComponent);

Pre-Condition

Object is fully constructed.

Description

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

Post-Condition

The authority is updated to exclude the specified component.

Parameters

TAuthorityComponent aComponent An enum specifying the component to be removed.