RQoSPolicy Class Reference

class RQoSPolicy

An interface to manage QoS policies and QoS policy files. RQoSPolicy::Open must always be called before any other methods in the RQoSPolicy can be called. Note that only one request can be pending at once (QoS event should be received before issuing next request).

Constructor & Destructor Documentation

RQoSPolicy()

IMPORT_C RQoSPolicy ( )

Default constructor.

RQoSPolicy::Open() must always be called before any other methods in the RQoSPolicy can be called.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

~RQoSPolicy()

IMPORT_C ~RQoSPolicy ( )

Destructor.

Closes any open policy.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Member Functions Documentation

CancelNotifyEvent(MQoSObserver &)

IMPORT_C TInt CancelNotifyEvent ( MQoSObserver & aObserver )

Deregisters an event observer to catch QoS events.

Deregisters an event observer to catch QoS events.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

MQoSObserver & aObserver Event observer.

Close()

IMPORT_C TInt Close ( )

Deletes the QoS policy. Deletes the QoS policy.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

GetQoS()

IMPORT_C TInt GetQoS ( )

Gets the QoS policy from QoS policy database. CQoSGetEvent event is received asynchronously to indicate the success of failure of the request.

Gets the QoS policy from QoS policy database.

A CQoSGetEvent event is received asynchronously to indicate the success or failure of the request.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

LoadPolicyFile(const TDesC &)

IMPORT_C TInt LoadPolicyFile ( const TDesC & aName )

Loads a QoS policy file into the QoS policy database. EQoSEventLoadPolicyFile event is received asynchronously to indicate the success of failure of the request.

Loads a QoS policy file into the QoS policy database.

A TQoSEvent event (EQoSEventLoadPolicyFile) is received asynchronously to indicate the success or failure of the request.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TDesC & aName Name of the QoS policy file to be loaded.

NotifyEvent(MQoSObserver &, TUint)

IMPORT_C TInt NotifyEvent ( MQoSObserver & aObserver,
TUint aMask =  KQoSEventAll
)

Registers an event observer to catch QoS events.

Registers an event observer to catch QoS events.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

MQoSObserver & aObserver Event observer.
TUint aMask =  KQoSEventAll An event mask. An application can specify a set of QoS events that it wants to receive. By default all events are notified to the application. See TQoSEvent enumerations.

Open(const TQoSSelector &)

IMPORT_C TInt Open ( const TQoSSelector & aSelector )

RQoSPolicy::Open must always be called before any other method can be used. Specifies the selector for a QoS policy.

This must always be called before any other function can be used.

It specifies the selector for a QoS policy.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TQoSSelector & aSelector Selector for the QoS policy.

SetQoS(CQoSParameters &)

IMPORT_C TInt SetQoS ( CQoSParameters & aPolicy )

Sets the QoS parameters for the QoS policy. CQoSAddEvent event is received asynchronously to indicate the success of failure of the request.

Sets the QoS parameters for the QoS policy.

A CQoSAddEvent event is received asynchronously to indicate the success or failure of the request.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

CQoSParameters & aPolicy QoS parameters.

UnloadPolicyFile(const TDesC &)

IMPORT_C TInt UnloadPolicyFile ( const TDesC & aName )

Unloads a QoS policy file from the QoS policy database. EQoSEventUnloadPolicyFile event is received asynchronously to indicate the success of failure of the request.

Unloads a QoS policy file from the QoS policy database.

A TQoSEvent event (EQoSEventUnloadPolicyFile) is received asynchronously to indicate the success or failure of the request.

capability
NetworkControl Restrict QoS policy operations because they may affect several data flows.

Parameters

const TDesC & aName Name of the QoS policy file to be unloaded.

Member Data Documentation

CPolicy * iPolicy

CPolicy * iPolicy [private]

A dynamically allocated QoS policy.