CommsFW::CCFChannelPairRawBase Class Reference

class CommsFW::CCFChannelPairRawBase : public CActive

Inherits from

Public Member Functions
CCFChannelPairRawBase ( TInt , RMsgQueueBase *, RCFChannelRawBase &, RMsgQueueBase *, RCFChannelRawBase &, TInt , TInt )
~CCFChannelPairRawBase ()
IMPORT_C void CancelDataAvailable ()
IMPORT_C void CancelSpaceAvailable ( TInt )
IMPORT_C TInt CloseGracefully ( TInt )
IMPORT_C void CloseNonGracefully ()
IMPORT_C TInt CreateRecv (const RMsgQueueBase *, TOwnerType )
IMPORT_C TInt CreateRecv ( TInt )
IMPORT_C TInt CreateSend (const RMsgQueueBase *, TOwnerType )
IMPORT_C TInt CreateSend ( TInt )
IMPORT_C void GetRecvMsgQueues ( RMsgQueueBase *)
IMPORT_C void GetSendMsgQueues ( RMsgQueueBase *)
IMPORT_C void NotifyDataAvailable ( TRequestStatus &)
IMPORT_C void NotifySpaceAvailable ( TRequestStatus &, TInt )
TInt RawReceive ( TAny *)
IMPORT_C TInt Receive ( TAny *)
IMPORT_C TInt Send (const TAny *, TInt )
Protected Member Functions
IMPORT_C void DoCancel ()
IMPORT_C TBool DoSendPIG (const TAny *)
IMPORT_C TBool IsMsgPIG (const TAny *)
IMPORT_C void RunL ()
IMPORT_C TBool SendPIG ()
Private Member Functions
void HaltRx ()
void HaltTx ()
TBool RxHalted ()
TInt TimerElapsed ( TAny *)
TBool TxHalted ()
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()
Inherited Enumerations
CActive:TPriority
Private Attributes
CPeriodic * iCloseTimer
TUint8 iFlags
TUint8 iPriorities
RCFChannelRawBase & iRxChannel
RMsgQueueBase * iRxQueues
TUint16 iSize
RCFChannelRawBase & iTxChannel
RMsgQueueBase * iTxQueues
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CCFChannelPairRawBase(TInt, RMsgQueueBase *, RCFChannelRawBase &, RMsgQueueBase *, RCFChannelRawBase &, TInt, TInt)

IMPORT_C CCFChannelPairRawBase ( TInt aAOPriority,
RMsgQueueBase * aRxQueues,
RCFChannelRawBase & aRxChannel,
RMsgQueueBase * aTxQueues,
RCFChannelRawBase & aTxChannel,
TInt aSize,
TInt aChannelPriorities
)

Defines message queues data structure for the array of internal message queues in a channel. Used when getting the array of message queues in and out of the channel instance.

Parameters

TInt aAOPriority
RMsgQueueBase * aRxQueues
RCFChannelRawBase & aRxChannel
RMsgQueueBase * aTxQueues
RCFChannelRawBase & aTxChannel
TInt aSize
TInt aChannelPriorities

~CCFChannelPairRawBase()

IMPORT_C ~CCFChannelPairRawBase ( )

Member Functions Documentation

CancelDataAvailable()

IMPORT_C void CancelDataAvailable ( )

CancelSpaceAvailable(TInt)

IMPORT_C void CancelSpaceAvailable ( TInt aPriority )

Parameters

TInt aPriority

CloseGracefully(TInt)

IMPORT_C TInt CloseGracefully ( TInt aGracefulCloseTimeout )

Parameters

TInt aGracefulCloseTimeout

CloseNonGracefully()

IMPORT_C void CloseNonGracefully ( )

CreateRecv(const RMsgQueueBase *, TOwnerType)

IMPORT_C TInt CreateRecv ( const RMsgQueueBase * aForeignQueues,
TOwnerType aOwner
)

Parameters

const RMsgQueueBase * aForeignQueues
TOwnerType aOwner

CreateRecv(TInt)

IMPORT_C TInt CreateRecv ( TInt aSlots )

Parameters

TInt aSlots

CreateSend(const RMsgQueueBase *, TOwnerType)

IMPORT_C TInt CreateSend ( const RMsgQueueBase * aForeignQueues,
TOwnerType aOwner
)

Parameters

const RMsgQueueBase * aForeignQueues
TOwnerType aOwner

CreateSend(TInt)

IMPORT_C TInt CreateSend ( TInt aSlots )

Parameters

TInt aSlots

DoCancel()

IMPORT_C 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

DoSendPIG(const TAny *)

IMPORT_C TBool DoSendPIG ( const TAny * aMsgPIG ) [protected]

Parameters

const TAny * aMsgPIG

GetRecvMsgQueues(RMsgQueueBase *)

IMPORT_C void GetRecvMsgQueues ( RMsgQueueBase * aForeignQueues ) const

Parameters

RMsgQueueBase * aForeignQueues

GetSendMsgQueues(RMsgQueueBase *)

IMPORT_C void GetSendMsgQueues ( RMsgQueueBase * aForeignQueues ) const

Parameters

RMsgQueueBase * aForeignQueues

HaltRx()

void HaltRx ( ) [private]

HaltTx()

void HaltTx ( ) [private]

IsMsgPIG(const TAny *)

IMPORT_C TBool IsMsgPIG ( const TAny * aMsg ) [protected, virtual]

Parameters

const TAny * aMsg

NotifyDataAvailable(TRequestStatus &)

IMPORT_C void NotifyDataAvailable ( TRequestStatus & aStatus )

Parameters

TRequestStatus & aStatus

NotifySpaceAvailable(TRequestStatus &, TInt)

IMPORT_C void NotifySpaceAvailable ( TRequestStatus & aStatus,
TInt aPriority
)

Parameters

TRequestStatus & aStatus
TInt aPriority

RawReceive(TAny *)

TInt RawReceive ( TAny * aMsg )

Parameters

TAny * aMsg

Receive(TAny *)

IMPORT_C TInt Receive ( TAny * aMsg )

Parameters

TAny * aMsg

RunL()

IMPORT_C 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

RxHalted()

TBool RxHalted ( ) [private]

Send(const TAny *, TInt)

IMPORT_C TInt Send ( const TAny * aMsg,
TInt aPriority
)

Parameters

const TAny * aMsg
TInt aPriority

SendPIG()

IMPORT_C TBool SendPIG ( ) [protected, virtual]

TimerElapsed(TAny *)

TInt TimerElapsed ( TAny * aAnyThis ) [private, static]

Parameters

TAny * aAnyThis

TxHalted()

TBool TxHalted ( ) [private]

Member Data Documentation

CPeriodic * iCloseTimer

CPeriodic * iCloseTimer [private]

TUint8 iFlags

TUint8 iFlags [private]

TUint8 iPriorities

TUint8 iPriorities [private]

RCFChannelRawBase & iRxChannel

RCFChannelRawBase & iRxChannel [private]

RMsgQueueBase * iRxQueues

RMsgQueueBase * iRxQueues [private]

TUint16 iSize

TUint16 iSize [private]

RCFChannelRawBase & iTxChannel

RCFChannelRawBase & iTxChannel [private]

RMsgQueueBase * iTxQueues

RMsgQueueBase * iTxQueues [private]