Collapse all Symbian^3 Application Developer Library

RUsbHubDriver Class Reference

class RUsbHubDriver : public RBusLogicalChannel

Functions which act on the local hub driver. Higher level components cannot determine which host controller is in use, although the presence of Other Speed descriptors may give some hints.

Note:

This API is only available to the function driver framework, a restriction which is enforced by checking the SID of the calling process.

Inherits from

RUsbHubDriver
- RBusLogicalChannel
  - RHandleBase

Nested Classes and Structures

RUsbHubDriver::TBusEvent

Public Member Functions
void	CancelWaitForBusEvent ()
const TDesC &	Name ()
TInt	Open ()
TInt	StartHost ()
void	StopHost ()
TVersion	VersionRequired ()
void	WaitForBusEvent ( TBusEvent &, TRequestStatus &)

Inherited Functions
	RBusLogicalChannel::DoCancel(TUint)
	RBusLogicalChannel::DoControl(TInt)
	RBusLogicalChannel::DoControl(TInt,TAny *)
	RBusLogicalChannel::DoControl(TInt,TAny ,TAny )
	RBusLogicalChannel::DoCreate(const TDesC &,const TVersion &,TInt,const TDesC ,const TDesC8 ,TOwnerType,TBool)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny *)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny ,TAny )
	RBusLogicalChannel::DoSvControl(TInt)
	RBusLogicalChannel::DoSvControl(TInt,TAny *)
	RBusLogicalChannel::DoSvControl(TInt,TAny ,TAny )
	RBusLogicalChannel::Open(RMessagePtr2,TInt,TOwnerType)
	RBusLogicalChannel::Open(TInt,TOwnerType)
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RHandleBase::SetReturnedHandle(TInt)
	RHandleBase::SetReturnedHandle(TInt,RHandleBase &)

Public Member Enumerations
enum	TUsbHubDriverCancel { ECancelWaitForBusEvent = 0x00000001 }
enum	TUsbHubDriverControl { EStartHost , EStopHost }
enum	TUsbHubDriverRequest { EWaitForBusEvent }

Inherited Enumerations
	RHandleBase:TAttributes

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

CancelWaitForBusEvent()

void

CancelWaitForBusEvent

(

)

[inline]

Cancel a request to wait for bus events.

Name()

const TDesC &

Name

(

)

[static, inline]

Open()

TInt

Open

(

)

[inline]

Open a handle to the host controller.

StartHost()

TInt

StartHost

(

)

[inline]

Start the host stack.

StopHost()

void

StopHost

(

)

[inline]

Stop the host stack.

VersionRequired()

TVersion

VersionRequired

(

)

[static, inline]

The driver's version

WaitForBusEvent(TBusEvent &, TRequestStatus &)

void	WaitForBusEvent	(	TBusEvent &	aEvent,
			TRequestStatus &	aRequest
		)	[inline]

Wait for a bus event. These include device attachments and detachments. TBusEvent

Parameters

TBusEvent & aEvent	The details of the event that occured, filled in when the request completes.
TRequestStatus & aRequest	Completed when an event occurs

Member Enumerations Documentation

Enum TUsbHubDriverCancel

Enumerators

ECancelWaitForBusEvent = 0x00000001

Enum TUsbHubDriverControl

Enumerators

EStartHost
EStopHost

Enum TUsbHubDriverRequest

Enumerators

EWaitForBusEvent