Collapse all Symbian^3 Application Developer Library

CUsbClassControllerBase Class Reference

class CUsbClassControllerBase : public CActive

Base class for Class Controllers.

Inherits from

CUsbClassControllerBase
- CActive
  - CBase

Public Member Functions
	~CUsbClassControllerBase ()
IMPORT_C TInt	Compare (const CUsbClassControllerBase &, const CUsbClassControllerBase &)
void	DoCancel ()
void	GetDescriptorInfo (TUsbDescriptor &)
IMPORT_C MUsbClassControllerNotify &	Owner ()
TInt	RunError ( TInt )
void	RunL ()
void	Start ( TRequestStatus &)
IMPORT_C TInt	StartupPriority ()
IMPORT_C TUsbServiceState	State ()
void	Stop ( TRequestStatus &)

Protected Member Functions
	CUsbClassControllerBase ( MUsbClassControllerNotify &, TInt )

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()

Inherited Enumerations
	CActive:TPriority

Protected Attributes
MUsbClassControllerNotify &	iOwner
const TInt	iStartupPriority
TUsbServiceState	iState

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CUsbClassControllerBase(MUsbClassControllerNotify &, TInt)

IMPORT_C	CUsbClassControllerBase	(	MUsbClassControllerNotify &	aOwner,
			TInt	aStartupPriority
		)	[protected]

Constructor Constructor.

Parameters

MUsbClassControllerNotify & aOwner	Owner and manager of this object
TInt aStartupPriority	The priority of the Class Controller (the priorities of all present Class Controllers determines the order in which they are started).

~CUsbClassControllerBase()

IMPORT_C

~CUsbClassControllerBase

(

)

[virtual]

Destructor

Destructor.

Member Functions Documentation

Compare(const CUsbClassControllerBase &, const CUsbClassControllerBase &)

IMPORT_C TInt	Compare	(	const CUsbClassControllerBase &	aFirst,
			const CUsbClassControllerBase &	aSecond
		)	[static]

Compare Static function to compare two class controllers on the basis of their startup priorities.

Parameters

const CUsbClassControllerBase & aFirst	First class controller.
const CUsbClassControllerBase & aSecond	Second class controller.

DoCancel()

void

DoCancel

(

)

[pure virtual]

DoCancel Framework function.

GetDescriptorInfo(TUsbDescriptor &)

void

GetDescriptorInfo

(

TUsbDescriptor &

aDescriptorInfo

)

const [pure virtual]

GetDescriptorInfo Returns information on the class controller's descriptors.

Parameters

TUsbDescriptor & aDescriptorInfo

Structure to return information in.

Owner()

IMPORT_C MUsbClassControllerNotify &

Owner

(

)

const

Owner Fetch the owner of the USB class controller.

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[pure virtual]

RunError

Parameters

TInt aError

The error with which RunL left.

RunL()

void

RunL

(

)

[pure virtual]

RunL Framework function. Class controllers are Active Objects, and may if relevant use that to register interfaces asynchronously.

Start(TRequestStatus &)

void

Start

(

TRequestStatus &

aStatus

)

[pure virtual]

Start Called by the server to get this class controller to register its interfaces.

Parameters

TRequestStatus & aStatus

TRequestStatus to signal completion of the request.

StartupPriority()

IMPORT_C TInt

StartupPriority

(

)

const

StartupPriority Get the startup priority of this USB class controller.

State()

IMPORT_C TUsbServiceState

State

(

)

const

State Get the state of this USB class controller.

Stop(TRequestStatus &)

void

Stop

(

TRequestStatus &

aStatus

)

[pure virtual]

Stop Called by the server to get this class controller to deregister its interfaces.

Parameters

TRequestStatus & aStatus

TRequestStatus to signal completion of the request.

Member Data Documentation

MUsbClassControllerNotify & iOwner

MUsbClassControllerNotify &

iOwner

[protected]

Owner.

const TInt iStartupPriority

const TInt

iStartupPriority

[protected]

The relative priority of this class controller. The class controllers are sorted using their priorities to determine what order to start them in.

TUsbServiceState iState

TUsbServiceState

iState

[protected]

The current service state. This must be kept up-to-date depending on whether this class controller's interfaces are registered or not.