CSensrvMediatorBase Class Reference

class CSensrvMediatorBase : public CActive

Mediates control flow between sensor server main thread (aka server thread) and the plugin threads. Each plugin has one mediator for server thread and one mediator for plugin thread, and control is passed to different thread by notifying the mediator of that thread.

Since
S60 5.0

Inherits from

Constructor & Destructor Documentation

CSensrvMediatorBase()

CSensrvMediatorBase ( ) [protected]

C++ constructor

Since
S60 5.0

~CSensrvMediatorBase()

~CSensrvMediatorBase ( ) [virtual]

Destructor.

Member Functions Documentation

BaseConstructL(CSensrvPluginProxy *)

void BaseConstructL ( CSensrvPluginProxy * aProxy ) [protected]
2nd phase of construction. This method must be called during child class construction.
Since
S60 5.0

Parameters

CSensrvPluginProxy * aProxy The proxy controlling related plugin.

BaseDestruct()

void BaseDestruct ( )

Used to destruct object without calling destructor.

CompleteRequest(TInt)

void CompleteRequest ( TInt aReason ) [protected]

Completes this object's request, if it is active and notifications are enabled.

Since
S60 5.0

Parameters

TInt aReason Reason of completion

DoCancel()

void DoCancel ( ) [protected, 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

HandleNotifyFailure()

void HandleNotifyFailure ( ) [protected, pure virtual]

Handles notify failure

Since
S60 5.0

HandleTransaction(CSensrvTransaction *)

void HandleTransaction ( CSensrvTransaction * aTransaction ) [protected, pure virtual]

Handles transaction. Handling depends on mediator type, so this must be implemented in inheriting class.

Since
S60 5.0

Parameters

CSensrvTransaction * aTransaction The transaction to be handled.

Initialize()

TInt Initialize ( ) [virtual]

Initializes the mediator. Must be called from thread this mediator mediates. If child class overloads this, base implementation must be called also.

Since
S60 5.0

Notify(CSensrvTransaction *)

TInt Notify ( CSensrvTransaction * aTransaction )

Notifies the mediator that new transaction needs handling by the thread mediated by this mediator. Called from any thread.

Since
S60 5.0

Parameters

CSensrvTransaction * aTransaction The new transaction to be handled. If transaction is NULL, Notify() is guaranteed to return KErrNone.

RemoveAllTransactions()

void RemoveAllTransactions ( )

Removes all transactions from queue. This method is only called from server thread.

Since
S60 5.0

RemoveSingleTransaction(CSensrvTransaction *)

void RemoveSingleTransaction ( CSensrvTransaction * aTransaction )

Removes single transaction from queue. This method is only called from server thread.

Since
S60 5.0

Parameters

CSensrvTransaction * aTransaction

RunError(TInt)

TInt RunError ( TInt aError ) [protected, virtual]

Parameters

TInt aError

RunL()

void RunL ( ) [protected, 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

SessionTerminated(CSensrvSession *)

void SessionTerminated ( CSensrvSession * aSession )

Removes all transactions initiated by specified session from queue. This method is only called from server thread.

Since
S60 5.0

Parameters

CSensrvSession * aSession The session which is being deleted.

Member Data Documentation

TBool iInitialized

TBool iInitialized [protected]

Indicates if this object has already been initialized

RMutex * iMutex

RMutex * iMutex [protected]

Mutex pointer. If mediator is created in server main thread, this points to proxy's mutex, otherwise it is a duplicate handle.

Must be initialized and cleaned by child class.

TBool iNotifyFailed

TBool iNotifyFailed [private]

Indicates that at least one notify has failed

CSensrvPluginProxy * iProxy

CSensrvPluginProxy * iProxy [protected]

Parent proxy of this mediator. Not own.

CSensrvTransactionQueue * iQueue

CSensrvTransactionQueue * iQueue [protected]

Holds transaction pointers of transactions queued at this mediator. Own.

RThread iThread

RThread iThread [protected]

Thread handle for owning thread