CommsFW::CChannelDrain::CQueueDrain Class Reference

class CommsFW::CChannelDrain::CQueueDrain : public CActive

Inherits from

Constructor & Destructor Documentation

CQueueDrain()

CQueueDrain()

Member Functions Documentation

DoCancel()

voidDoCancel()[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

NotifyDataAvailable(RMsgQueueBase &)

voidNotifyDataAvailable(RMsgQueueBase &aQueue)

Parameters

RMsgQueueBase & aQueue

RunL()

voidRunL()[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

SetParentChannel(CChannelDrain &)

voidSetParentChannel(CChannelDrain &aChannelDrain)

Parameters

CChannelDrain & aChannelDrain

Member Data Documentation

CChannelDrain * iChannelDrain

CChannelDrain *iChannelDrain[private]