Symbian^3 Application Developer Library >

CommsFW::RCFChannelPairBase Class Reference

class CommsFW::RCFChannelPairBase : public CommsFW::CCFChannelPairRawBase

Active object encapsulating channels in opposed pairs so as to get bi- directional communication. Supports graceful close to protect against race conditions when closing the two channel endpoints.

Inherits from

Public Member Functions
RCFChannelPairBase ( TInt )
void CancelDataAvailable ()
void CancelSpaceAvailable ( TInt )
TInt CloseGracefully ( TInt )
void CloseNonGracefully ()
TInt CreateRecv (const TMsgQueues &, TOwnerType )
TInt CreateRecv ( TInt )
TInt CreateSend (const TMsgQueues &, TOwnerType )
TInt CreateSend ( TInt )
void GetRecvMsgQueues ( TMsgQueues &)
void GetSendMsgQueues ( TMsgQueues &)
void NotifyDataAvailable ( TRequestStatus &)
void NotifyDataAvailable ( CActive &)
void NotifySpaceAvailable ( TRequestStatus &, TInt )
void NotifySpaceAvailable ( CActive &, TInt )
TInt RawReceive (T &)
TInt Receive (T &)
TInt Send (const T &, TInt )
Protected Member Functions
TBool IsMsgPIG (const TAny *)
TBool SendPIG ()
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()
CommsFW::CCFChannelPairRawBase::CCFChannelPairRawBase(TInt,RMsgQueueBase *,RCFChannelRawBase &,RMsgQueueBase *,RCFChannelRawBase &,TInt,TInt)
CommsFW::CCFChannelPairRawBase::CreateRecv(const RMsgQueueBase *,TOwnerType)
CommsFW::CCFChannelPairRawBase::CreateSend(const RMsgQueueBase *,TOwnerType)
CommsFW::CCFChannelPairRawBase::DoCancel()
CommsFW::CCFChannelPairRawBase::DoSendPIG(const TAny *)
CommsFW::CCFChannelPairRawBase::GetRecvMsgQueues(RMsgQueueBase *)const
CommsFW::CCFChannelPairRawBase::GetSendMsgQueues(RMsgQueueBase *)const
CommsFW::CCFChannelPairRawBase::RawReceive(TAny *)
CommsFW::CCFChannelPairRawBase::Receive(TAny *)
CommsFW::CCFChannelPairRawBase::RunL()
CommsFW::CCFChannelPairRawBase::Send(const TAny *,TInt)
CommsFW::CCFChannelPairRawBase::~CCFChannelPairRawBase()
Inherited Enumerations
CActive:TPriority
Public Member Type Definitions
typedef struct RCFChannelBase < T, TPriorities >::TMsgQueuesTAG TMsgQueues
Private Attributes
RCFChannelBase < T, TPriorities > iRxChannel
RCFChannelBase < T, TPriorities > iTxChannel
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

RCFChannelPairBase(TInt)

RCFChannelPairBase ( TInt aAOPriority ) [inline]

Parameters

TInt aAOPriority

Member Functions Documentation

CancelDataAvailable()

void CancelDataAvailable ( ) [inline]

CancelSpaceAvailable(TInt)

void CancelSpaceAvailable ( TInt aPriority ) [inline]

Parameters

TInt aPriority

CloseGracefully(TInt)

TInt CloseGracefully ( TInt aGracefulCloseTimeout ) [inline]

Parameters

TInt aGracefulCloseTimeout

CloseNonGracefully()

void CloseNonGracefully ( ) [inline]

CreateRecv(const TMsgQueues &, TOwnerType)

TInt CreateRecv ( const TMsgQueues & aRxQueues,
TOwnerType aOwner = EOwnerThread
) [inline]

Parameters

const TMsgQueues & aRxQueues
TOwnerType aOwner = EOwnerThread

CreateRecv(TInt)

TInt CreateRecv ( TInt aSlots ) [inline]

Parameters

TInt aSlots

CreateSend(const TMsgQueues &, TOwnerType)

TInt CreateSend ( const TMsgQueues & aTxQueues,
TOwnerType aOwner = EOwnerThread
) [inline]

Parameters

const TMsgQueues & aTxQueues
TOwnerType aOwner = EOwnerThread

CreateSend(TInt)

TInt CreateSend ( TInt aSlots ) [inline]

Parameters

TInt aSlots

GetRecvMsgQueues(TMsgQueues &)

void GetRecvMsgQueues ( TMsgQueues & aMsgQueues ) const [inline]

Parameters

TMsgQueues & aMsgQueues

GetSendMsgQueues(TMsgQueues &)

void GetSendMsgQueues ( TMsgQueues & aMsgQueues ) const [inline]

Parameters

TMsgQueues & aMsgQueues

IsMsgPIG(const TAny *)

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

Parameters

const TAny * aMsg

NotifyDataAvailable(TRequestStatus &)

void NotifyDataAvailable ( TRequestStatus & aStatus ) [inline]

Parameters

TRequestStatus & aStatus

NotifyDataAvailable(CActive &)

void NotifyDataAvailable ( CActive & aRequester ) [inline]

Parameters

CActive & aRequester

NotifySpaceAvailable(TRequestStatus &, TInt)

void NotifySpaceAvailable ( TRequestStatus & aStatus,
TInt aPriority
) [inline]

Parameters

TRequestStatus & aStatus
TInt aPriority

NotifySpaceAvailable(CActive &, TInt)

void NotifySpaceAvailable ( CActive & aRequester,
TInt aPriority
) [inline]

Parameters

CActive & aRequester
TInt aPriority

RawReceive(T &)

TInt RawReceive ( T & aMsg ) [inline]

Parameters

T & aMsg

Receive(T &)

TInt Receive ( T & aMsg ) [inline]

Parameters

T & aMsg

Send(const T &, TInt)

TInt Send ( const T & aMsg,
TInt aPriority
) [inline]

Parameters

const T & aMsg
TInt aPriority

SendPIG()

TBool SendPIG ( ) [protected, inline, virtual]

Member Type Definitions Documentation

Typedef TMsgQueues

typedef struct RCFChannelBase < T, TPriorities >::TMsgQueuesTAG TMsgQueues

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.

Member Data Documentation

RCFChannelBase< T, TPriorities > iRxChannel

RCFChannelBase < T, TPriorities > iRxChannel [private]

RCFChannelBase< T, TPriorities > iTxChannel

RCFChannelBase < T, TPriorities > iTxChannel [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.