Collapse all Symbian^3 Product Developer Library

MTransportLayer Class Reference

class MTransportLayer

Transport layer interface class Interface allowing the generic HID layer to pass data to a Transport layer All commands are asynchronous. The results are returned via the

Since: S60 v5.0

Public Member Functions
TUint	CountryCodeL(TInt)
void	DataOutL(TInt, TUint8, TUint16, const TDesC8 &)
void	GetIdleL(TInt, TUint8, TUint16)
void	GetProtocolL(TInt, TUint16)
void	GetReportL(TInt, TUint8, TUint8, TUint16, TUint16)
TUint	ProductIdL(TInt)
void	SetIdleL(TInt, TUint8, TUint8, TUint16)
void	SetProtocolL(TInt, TUint16, TUint16)
void	SetReportL(TInt, TUint8, TUint8, TUint16, const TDesC8 &)
TUint	VendorIdL(TInt)

Member Functions Documentation

CountryCodeL(TInt)

TUint

CountryCodeL

(

TInt

aConnID

)

[pure virtual]

Request for the country code of the given device.

Since: S60 v5.0

Parameters

TInt aConnID

The device identifier

DataOutL(TInt, TUint8, TUint16, const TDesC8 &)

void	DataOutL	(	TInt	aConnID,
			TUint8	aReportID,
			TUint16	aInterface,
			const TDesC8 &	aReport
		)	[pure virtual]

Request to send data to a device. There are no responses to this report from device.

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint8 aReportID	The specific report required
TUint16 aInterface	The interface we want to send the report to
const TDesC8 & aReport	The report payload to be sent to the device

GetIdleL(TInt, TUint8, TUint16)

void	GetIdleL	(	TInt	aConnID,
			TUint8	aReportID,
			TUint16	aInterface
		)	[pure virtual]

Request for the current idle rate of a report from the device. The response will be recevied via the CHidTransport::DataIn function

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint8 aReportID	The specific report to be queried
TUint16 aInterface	The interface we want to query for idle rate

GetProtocolL(TInt, TUint16)

void	GetProtocolL	(	TInt	aConnID,
			TUint16	aInterface
		)	[pure virtual]

Request for the current device report protocol. The protocol will be received as a control report via the CHidTransport::DataIn function

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint16 aInterface	The interface we want to get the protocol from

GetReportL(TInt, TUint8, TUint8, TUint16, TUint16)

void	GetReportL	(	TInt	aConnID,
			TUint8	aReportType,
			TUint8	aReportID,
			TUint16	aInterface,
			TUint16	aLength
		)	[pure virtual]

Request for a device report. The data will be received as a control report via the CHidTransport::DataIn function

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint8 aReportType	The type of report (input/output/feature) requested
TUint8 aReportID	The specific report required
TUint16 aInterface	The interface we want the report from
TUint16 aLength	The expected length of the report buffer

ProductIdL(TInt)

TUint

ProductIdL

(

TInt

aConnID

)

[pure virtual]

Request for the product identifier for the given device.

Since: S60 v5.0

Parameters

TInt aConnID

The device identifier

SetIdleL(TInt, TUint8, TUint8, TUint16)

void	SetIdleL	(	TInt	aConnID,
			TUint8	aDuration,
			TUint8	aReportID,
			TUint16	aInterface
		)	[pure virtual]

Request to set the current idle rate for a report on the device. The response will be received via the CHidTransport::CommandResult function

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint8 aDuration	The time period between idle reports (4ms per bit. An interval of 0 disables idle reports so that Interrupt reports are only ever received when the reported data has changed
TUint8 aReportID	The specific report to be queried
TUint16 aInterface	The interface we want to query for idle rate

SetProtocolL(TInt, TUint16, TUint16)

void	SetProtocolL	(	TInt	aConnID,
			TUint16	aValue,
			TUint16	aInterface
		)	[pure virtual]

Request to put the device in the specified protocol

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint16 aValue	The requested protocol for the device (boot or report)
TUint16 aInterface	The interface we want to set the protocol for

SetReportL(TInt, TUint8, TUint8, TUint16, const TDesC8 &)

void	SetReportL	(	TInt	aConnID,
			TUint8	aReportType,
			TUint8	aReportID,
			TUint16	aInterface,
			const TDesC8 &	aReport
		)	[pure virtual]

Request to send a report to a device. The response will be reported via the CHidTransport::CommandResult function

Since: S60 v5.0

Parameters

TInt aConnID	The device identifier
TUint8 aReportType	The type of report (input/output/feature) requested
TUint8 aReportID	The specific report required to set
TUint16 aInterface	The interface we want to send the report to
const TDesC8 & aReport	The report payload to be sent to the device

VendorIdL(TInt)

TUint

VendorIdL

(

TInt

aConnID

)

[pure virtual]

Request for the vendor identifier for the given device.

Since: S60 v5.0

Parameters

TInt aConnID

The device identifier