Collapse all Symbian^3 Application Developer Library

CHidTransport Class Reference

class CHidTransport : public CBase

Hid transport interface Interface allowing the transport layer to pass data to the Generic HID

Since: S60 v5.0

Inherits from

CHidTransport
- CBase

Public Member Functions
void	CommandResult ( TInt , TInt )
TInt	ConnectedL ( TInt , const TDesC8 &)
TInt	DataIn ( TInt , THidChannelType , const TDesC8 &)
TInt	Disconnected ( TInt )
TInt	DriverActive ( TInt , CHidTransport::TDriverState )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Public Member Enumerations
enum	TDriverState { EActive , ESuspend }
enum	THidChannelType { EHidChannelInt , EHidChannelCtrl }

Member Functions Documentation

CommandResult(TInt, TInt)

void	CommandResult	(	TInt	aConnectionId,
			TInt	aCmdAck
		)	[pure virtual]

Called by the transport layers to inform the generic HID of the success of the last Set... command.

Since: S60 v5.0

Parameters

TInt aConnectionId	Transport layer connection enumeration
TInt aCmdAck	Status of the last Set... command

ConnectedL(TInt, const TDesC8 &)

TInt	ConnectedL	(	TInt	aConnectionId,
			const TDesC8 &	aDescriptor
		)	[pure virtual]

Called when a device has connected

Since: S60 v5.0

Parameters

TInt aConnectionId	The transport-layer enumeration for the connection
const TDesC8 & aDescriptor	The report descriptor for the device

DataIn(TInt, THidChannelType, const TDesC8 &)

TInt	DataIn	(	TInt	aConnectionId,
			THidChannelType	aChannel,
			const TDesC8 &	aPayload
		)	[pure virtual]

Called when a device has been disconnected

Since: S60 v5.0

Parameters

TInt aConnectionId	Transport layer connection enumeration
THidChannelType aChannel	Channel ID (Interrupt or Control)
const TDesC8 & aPayload	The complete report payload

Disconnected(TInt)

TInt

Disconnected

(

TInt

aConnectionId

)

[pure virtual]

Called when a device has been disconnected

Since: S60 v5.0

Parameters

TInt aConnectionId

The transport-layer enumeration for the connection

DriverActive(TInt, CHidTransport::TDriverState)

TInt	DriverActive	(	TInt	aConnectionId,
			CHidTransport::TDriverState	aActive
		)	[pure virtual]

Suspends or Resumes the driver(s) handling the connection

Since: S60 v5.0

Parameters

TInt aConnectionId	Transport layer connection enumeration
CHidTransport::TDriverState aActive	The requested state of the driver (active or suspended)

Member Enumerations Documentation

Enum TDriverState

Driver state (active or suspended)

Enumerators

EActive	Driver will handle interrupt data
ESuspend	the driver will not handle interrupt data

Enum THidChannelType

Defines the channel type for the DataIn function

Enumerators

EHidChannelInt	Interrupt channel
EHidChannelCtrl	Control channel