CMMFAddDataSourceSinkAsync Class Reference

class CMMFAddDataSourceSinkAsync : public CActive
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.
Since
8.0

Inherits from

Public Member Functions
~CMMFAddDataSourceSinkAsync()
IMPORT_C voidAddDataSink(RMMFController &, TUid, const TDesC8 &)
IMPORT_C voidAddDataSource(RMMFController &, TUid, const TDesC8 &)
IMPORT_C voidAddFileHandleDataSink(RMMFController &, const RFile &)
IMPORT_C voidAddFileHandleDataSink(RMMFController &, const RFile &, const TDesC8 &)
IMPORT_C voidAddFileHandleDataSource(RMMFController &, const RFile &)
IMPORT_C voidAddFileHandleDataSource(RMMFController &, const RFile &, const TDesC8 &)
IMPORT_C CMMFAddDataSourceSinkAsync *NewL(MMMFAddDataSourceSinkAsyncObserver &)
Private Member Functions
CMMFAddDataSourceSinkAsync(MMMFAddDataSourceSinkAsyncObserver &)
voidDoCancel()
voidRunL()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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 Member Enumerations
enumTCurrentAction { EIdle, EAddingDataSource, EAddingDataSink }
Inherited Enumerations
CActive:TPriority
Private Attributes
TCurrentAction iCurrentAction
TMMFMessageDestinationPckg iHandleInfoPckg
RMMFController *iMMFController
MMMFAddDataSourceSinkAsyncObserver &iObserver
HBufC8 *iSourceSinkInitData
TMMFUidPckg iSourceSinkUidPckg
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CMMFAddDataSourceSinkAsync(MMMFAddDataSourceSinkAsyncObserver &)

CMMFAddDataSourceSinkAsync(MMMFAddDataSourceSinkAsyncObserver &aObserver)[private]

Parameters

MMMFAddDataSourceSinkAsyncObserver & aObserver

~CMMFAddDataSourceSinkAsync()

~CMMFAddDataSourceSinkAsync()

Member Functions Documentation

AddDataSink(RMMFController &, TUid, const TDesC8 &)

IMPORT_C voidAddDataSink(RMMFController &aController,
TUidaSinkUid,
const TDesC8 &aSinkInitData
)

Parameters

RMMFController & aController
TUid aSinkUid
const TDesC8 & aSinkInitData

AddDataSource(RMMFController &, TUid, const TDesC8 &)

IMPORT_C voidAddDataSource(RMMFController &aController,
TUidaSourceUid,
const TDesC8 &aSourceInitData
)

Parameters

RMMFController & aController
TUid aSourceUid
const TDesC8 & aSourceInitData

AddFileHandleDataSink(RMMFController &, const RFile &)

IMPORT_C voidAddFileHandleDataSink(RMMFController &aController,
const RFile &aFile
)

Parameters

RMMFController & aController
const RFile & aFile

AddFileHandleDataSink(RMMFController &, const RFile &, const TDesC8 &)

IMPORT_C voidAddFileHandleDataSink(RMMFController &aController,
const RFile &aFile,
const TDesC8 &aSinkInitData
)

Parameters

RMMFController & aController
const RFile & aFile
const TDesC8 & aSinkInitData

AddFileHandleDataSource(RMMFController &, const RFile &)

IMPORT_C voidAddFileHandleDataSource(RMMFController &aController,
const RFile &aFile
)

Parameters

RMMFController & aController
const RFile & aFile

AddFileHandleDataSource(RMMFController &, const RFile &, const TDesC8 &)

IMPORT_C voidAddFileHandleDataSource(RMMFController &aController,
const RFile &aFile,
const TDesC8 &aSourceInitData
)

Parameters

RMMFController & aController
const RFile & aFile
const TDesC8 & aSourceInitData

DoCancel()

voidDoCancel()[private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's 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.

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

CActive::Cancel

NewL(MMMFAddDataSourceSinkAsyncObserver &)

IMPORT_C CMMFAddDataSourceSinkAsync *NewL(MMMFAddDataSourceSinkAsyncObserver &aObs)[static]

RunL()

voidRunL()[private, virtual]

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 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)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() 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 RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

Member Enumerations Documentation

Enum TCurrentAction

Enumerators

EIdle
EAddingDataSource
EAddingDataSink

Member Data Documentation

TCurrentAction iCurrentAction

TCurrentAction iCurrentAction[private]

TMMFMessageDestinationPckg iHandleInfoPckg

TMMFMessageDestinationPckg iHandleInfoPckg[private]

RMMFController * iMMFController

RMMFController *iMMFController[private]

MMMFAddDataSourceSinkAsyncObserver & iObserver

MMMFAddDataSourceSinkAsyncObserver &iObserver[private]

HBufC8 * iSourceSinkInitData

HBufC8 *iSourceSinkInitData[private]

TMMFUidPckg iSourceSinkUidPckg

TMMFUidPckg iSourceSinkUidPckg[private]