Class CMMFAddDataSourceSinkAsync

class CMMFAddDataSourceSinkAsync : public CActive;

Description

Active object utility class that can be used to add a data source or data sink to a controller plugin asynchronously. Once the command has been completed, the caller will be notified via the MMMFAddDataSourceSinkAsyncObserver interface.

Derivation

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

• CActive - The core class of the active object abstraction.

• CMMFAddDataSourceSinkAsync - Active object utility class that can be used to add a data source or data sink t...

Members

Defined in CMMFAddDataSourceSinkAsync:

• AddDataSink(RMMFController &,TUid,const TDesC8 &)Add a data sink to the controller. The caller will be signalled on completion vi...
• AddDataSource(RMMFController &,TUid,const TDesC8 &)Add a data source to the controller. The caller will be signalled on completion ...
• AddFileHandleDataSink(RMMFController &,const RFile &)
• AddFileHandleDataSource(RMMFController &,const RFile &)
• DoCancel()Implements cancellation of an outstanding request.
• NewL(MMMFAddDataSourceSinkAsyncObserver &)Constructs a CMMFAddDataSourceSinkAsync object.
• RunL()Handles an active object's request completion event.

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CMMFAddDataSourceSinkAsync* NewL(MMMFAddDataSourceSinkAsyncObserver &aObs);

Description

Constructs a CMMFAddDataSourceSinkAsync object.

Parameters

MMMFAddDataSourceSinkAsyncObserver &aObs A reference to the observer of the active object. The observer will be notified when the AddDataSource/Sink command is complete.

Return value

CMMFAddDataSourceSinkAsync * A pointer to the new object.

Leave codes

This method can leave with one of the standard system-wide error codes.

IMPORT_C void AddDataSource(RMMFController &aController, TUid aSourceUid, const TDesC8 &aSourceInitData);

Description

Add a data source to the controller. The caller will be signalled on completion via the MMMFAddDataSourceSinkAsyncObserver interface.

Only one method call may be outstanding on this object at any one time.

Parameters

RMMFController &aController A reference to the client controller interface class. TUid aSourceUid The uid of the data source to be added. For more information, see the documentation for the data source you wish to add. const TDesC8 &aSourceInitData Data used to initialise the data source. The exact contents of this data are dependent on the type of data source. For more information, see the documentation for the data source you wish to add.

IMPORT_C void AddFileHandleDataSource(RMMFController &aController, const RFile &aFile);

Description

Parameters

RMMFController &aController const RFile &aFile

IMPORT_C void AddDataSink(RMMFController &aController, TUid aSinkUid, const TDesC8 &aSinkInitData);

Description

Add a data sink to the controller. The caller will be signalled on completion via the MMMFAddDataSourceSinkAsyncObserver interface.

Only one method call may be outstanding on this object at any one time.

Parameters

RMMFController &aController A reference to the client controller interface class. TUid aSinkUid The uid of the data sink to be added. For more information, see the documentation for the data sink you wish to add. const TDesC8 &aSinkInitData Data used to initialise the data sink. The exact contents of this data are dependent on the type of data sink. For more information, see the documentation for the data sink you wish to add.

IMPORT_C void AddFileHandleDataSink(RMMFController &aController, const RFile &aFile);

Description

Parameters

RMMFController &aController const RFile &aFile

private: virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's CMMFAddDataSourceSinkAsync::RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

CMMFAddDataSourceSinkAsync::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CActive::RunError(TInt) to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's CMMFAddDataSourceSinkAsync::RunL() or CActive::RunError(TInt) functions.

See also:

• CActiveScheduler::Start()Starts a new wait loop under the control of the current active scheduler.
• CActiveScheduler::Error(TInt)constHandles the result of a leave occurring in an active object’s RunL() function.
• CActiveScheduler::WaitForAnyRequest()Wait for an asynchronous request to complete.

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

CMMFAddDataSourceSinkAsync::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.