CommsFW::TCFUnbindMsg Class Reference

class CommsFW::TCFUnbindMsg : public CommsFW::TCFCommsMessageId

Comms Unbind message. Sent to a CPM to request it to unbind a binding. Since a submodule can have bindings to several other submodules it is important to match both ends of the binding before closing it down.

Nested Classes and Structures

Public Member Functions
TCFUnbindMsg ( TId , const TCFSubModuleAddress *, const TCFSubModuleAddress *, TBool )
TBool PeerIsDead ()
const TCFSubModuleAddress * SubModule1 ()
const TCFSubModuleAddress * SubModule2 ()
Inherited Functions
CommsFW::TCFCommsMessage::TCFCommsMessage(TCodes)
CommsFW::TCFCommsMessageId::Identifier()const
CommsFW::TCFCommsMessageId::TCFCommsMessageId(TCFCommsMessage::TCodes,TId)
CommsFW::TCFMessage::TCFMessage()
CommsFW::TCFMessage::TCFMessage(TCode,TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::Code()const
TCFMessageBase< KCFMessageParamBlockSize >::Code(TCode)
TCFMessageBase< KCFMessageParamBlockSize >::IsPIGCode()const
TCFMessageBase< KCFMessageParamBlockSize >::MaxParamBlockSize()
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock()
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock()const
TCFMessageBase< KCFMessageParamBlockSize >::ParamBlock(TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock()
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock()const
TCFMessageBase< KCFMessageParamBlockSize >::RawBlock(TInt,const TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::SetPIGCode()
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase()
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase(TCode,TInt,TAny *)
TCFMessageBase< KCFMessageParamBlockSize >::TCFMessageBase(TInt,const TAny *)
Inherited Enumerations
CommsFW::TCFCommsMessage:TCodes
CommsFW::TCFCommsMessageId:@35
TCFMessageBase< KCFMessageParamBlockSize >:@30
TCFMessageBase< KCFMessageParamBlockSize >:@31
Public Member Type Definitions
typedef CommsFW::TCFUnbindMsg::TParamsTAG TParams

Constructor & Destructor Documentation

TCFUnbindMsg(TId, const TCFSubModuleAddress *, const TCFSubModuleAddress *, TBool)

TCFUnbindMsg ( TId aIdentifier,
const TCFSubModuleAddress * aSubModule1,
const TCFSubModuleAddress * aSubModule2,
TBool aPeerIsDead
) [inline]

Constructor for unbind comms message type.

Parameters

TId aIdentifier Unique code identifying the specific message instance.
const TCFSubModuleAddress * aSubModule1 Address of submodule within this module to unbind.
const TCFSubModuleAddress * aSubModule2 Address of remote sumodule to unbind.
TBool aPeerIsDead If ETrue this indicates that the other end of the binding to close is not responsive and the binding should be forced to end immediately. This module should not expect to be able to have any communication with the remote end prior to closing down the channels.

Member Functions Documentation

PeerIsDead()

TBool PeerIsDead ( ) const [inline]

SubModule1()

const TCFSubModuleAddress * SubModule1 ( ) const [inline]

SubModule2()

const TCFSubModuleAddress * SubModule2 ( ) const [inline]

Member Type Definitions Documentation

Typedef TParams

typedef CommsFW::TCFUnbindMsg::TParamsTAG TParams

Structure defining the layout of the parameters in the message.