MHCTLInterface Class Reference

class MHCTLInterface

Mixin for the HCTL API. This interface is to be used via the HCTL Plugin. CHCTLBase::GetInterface(TUid)

Member Functions Documentation

MhiGetAclDataTransportOverhead(TUint &, TUint &)

void MhiGetAclDataTransportOverhead ( TUint & aHeaderSize,
TUint & aTrailerSize
) const [pure virtual]

Get the HCTL layer ACL data header and trailer size

Parameters

TUint & aHeaderSize Outgoing parameter for retrieving ACL data header size
TUint & aTrailerSize Outgoing parameter for retrieving ACL data trailer size

MhiGetCommandTransportOverhead(TUint &, TUint &)

void MhiGetCommandTransportOverhead ( TUint & aHeaderSize,
TUint & aTrailerSize
) const [pure virtual]

Get the HCTL layer command header and trailer size

Parameters

TUint & aHeaderSize Outgoing parameter for retrieving command header size
TUint & aTrailerSize Outgoing parameter for retrieving command trailer size

MhiGetSynchronousDataTransportOverhead(TUint &, TUint &)

void MhiGetSynchronousDataTransportOverhead ( TUint & aHeaderSize,
TUint & aTrailerSize
) const [pure virtual]

Get the HCTL layer Synchronous data header and trailer size

Parameters

TUint & aHeaderSize Outgoing parameter for retrieving Synchronous data header size
TUint & aTrailerSize Outgoing parameter for retrieving Synchronous data trailer size

MhiSetChannelObserver(MHCTLChannelObserver &)

void MhiSetChannelObserver ( MHCTLChannelObserver & aChannelObserver ) [pure virtual]

Setter for the channel observer

Parameters

MHCTLChannelObserver & aChannelObserver The channel observer gets notification of channel open and close from HCTL

MhiSetControllerStateObserver(MControllerStateObserver &)

void MhiSetControllerStateObserver ( MControllerStateObserver & aControllerStateObserver ) [pure virtual]

Setter for the controller state observer

Parameters

MControllerStateObserver & aControllerStateObserver The controller state observer gets notification of changes in the controller state such as power on and off

MhiSetDataObserver(MHCTLDataObserver &)

void MhiSetDataObserver ( MHCTLDataObserver & aDataObserver ) [pure virtual]

Setter for Data Observer

Parameters

MHCTLDataObserver & aDataObserver The data observer gets notification of incoming data from HCTL

MhiSetEventObserver(MHCTLEventObserver &)

void MhiSetEventObserver ( MHCTLEventObserver & aEventObserver ) [pure virtual]

Setter for Event Observer

Parameters

MHCTLEventObserver & aEventObserver The event observer gets notification of incoming events from HCTL

MhiSetQdpPluginInterfaceFinder(MQdpPluginInterfaceFinder &)

void MhiSetQdpPluginInterfaceFinder ( MQdpPluginInterfaceFinder & aQDPPluginInterfaceFinder ) [pure virtual]

Setter for the qdp plugin interface finder

Parameters

MQdpPluginInterfaceFinder & aQDPPluginInterfaceFinder

MhiWriteAclData(const TDesC8 &)

TInt MhiWriteAclData ( const TDesC8 & aData ) [pure virtual]

Writes data out as an ACL data frame. The data should represent a single complete ACL data frame.

Parameters

const TDesC8 & aData Byte representation of an ACL data frame.

MhiWriteCommand(const TDesC8 &)

TInt MhiWriteCommand ( const TDesC8 & aData ) [pure virtual]

Writes data out as a command frame. The data should represent a single complete command frame.

Parameters

const TDesC8 & aData Byte representation of a command frame.

MhiWriteSynchronousData(const TDesC8 &)

TInt MhiWriteSynchronousData ( const TDesC8 & aData ) [pure virtual]

Writes data out as a Synchronous data frame. The data should represent a single complete Synchronous data frame.

Parameters

const TDesC8 & aData Byte representation of a Synchronous data frame.