Collapse all Symbian^3 Product Developer Library

RBTPowerControl Class Reference

class RBTPowerControl

API used for managing the power state of the controller

Public Member Functions
	RBTPowerControl()
IMPORT_C void	Cancel()
IMPORT_C void	Close()
IMPORT_C TInt	GetPower(TBTPowerState &, TDes8 *)
IMPORT_C TInt	Open()
IMPORT_C void	SetPower(TBTPowerState, TDes8 *, TRequestStatus &)

Private Attributes
RHCIServerSession *	iHCIServerSession
TUint32	iReserved

Constructor & Destructor Documentation

RBTPowerControl()

IMPORT_C

RBTPowerControl

(

)

Member Functions Documentation

Cancel()

IMPORT_C void

Cancel

(

)

Cancels asynchronous requests made through this handle to the power control interface.

panic: KBTPowerControlPanic EApiUsedWhenHandleIsNotOpen If called when the RBTPowerControl instance has not been opened.

Close()

IMPORT_C void

(

)

Closes the handle to the Bluetooth power control interface.

Note that it is safe to call this multiple times.

GetPower(TBTPowerState &, TDes8 *)

IMPORT_C TInt	GetPower	(	TBTPowerState &	aState,
			TDes8 *	aDesc
		)

Makes a synchronous request to get the current power state of the Bluetooth hardware.

panic: KBTPowerControlPanic EApiUsedWhenHandleIsNotOpen If called when the RBTPowerControl instance has not been opened.

Parameters

TBTPowerState & aState	Set (on return) to the current power state if request was successful.
TDes8 * aDesc

Open()

IMPORT_C TInt

Open

(

)

Opens the handle to the power control interface for the Bluetooth hardware.

panic: KBTPowerControlPanic EHandleIsAlreadyOpen If the RBTPowerControl instance has already been opened (and not subsequently closed).

SetPower(TBTPowerState, TDes8 *, TRequestStatus &)

IMPORT_C void	SetPower	(	TBTPowerState	aState,
			TDes8 *	aDesc,
			TRequestStatus &	aStatus
		)

Makes an asynchronous request to set the power state of the Bluetooth hardware.

panic: KBTPowerControlPanic EApiUsedWhenHandleIsNotOpen If called when the RBTPowerControl instance has not been opened.

Parameters

TBTPowerState aState	The desired state.
TDes8 * aDesc
TRequestStatus & aStatus	The TRequestStatus that will signal the result of the request when completed.

Member Data Documentation

RHCIServerSession * iHCIServerSession

RHCIServerSession *

iHCIServerSession

[private]

TUint32 iReserved

TUint32

iReserved

[private]