Collapse all Symbian^3 Application Developer Library

TBTLocalDevice Class Reference

class TBTLocalDevice

Class used to exchange the local settings with the Registry server.

Not a complete set of details of the local device

Public Member Functions
	TBTLocalDevice ()
IMPORT_C TBool	AFHChannelAssessmentMode ()
IMPORT_C TBool	AcceptPairedOnlyMode ()
IMPORT_C const TBTDevAddr &	Address ()
IMPORT_C TUint32	DeviceClass ()
IMPORT_C const TDesC8 &	DeviceName ()
IMPORT_C TBool	IsValidAFHChannelAssessmentMode ()
IMPORT_C TBool	IsValidAcceptPairedOnlyMode ()
IMPORT_C TBool	IsValidAddress ()
IMPORT_C TBool	IsValidDeviceClass ()
IMPORT_C TBool	IsValidDeviceName ()
IMPORT_C TBool	IsValidLimitedDiscoverable ()
IMPORT_C TBool	IsValidPowerSetting ()
IMPORT_C TBool	IsValidScanEnable ()
IMPORT_C TBool	LimitedDiscoverable ()
IMPORT_C TUint8	PowerSetting ()
IMPORT_C THCIScanEnable	ScanEnable ()
IMPORT_C void	SetAFHChannelAssessmentMode ( TBool )
IMPORT_C void	SetAcceptPairedOnlyMode ( TBool )
IMPORT_C void	SetAddress (const TBTDevAddr &)
IMPORT_C void	SetDeviceClass ( TUint32 )
IMPORT_C void	SetDeviceName (const TDesC8 &)
IMPORT_C void	SetLimitedDiscoverable ( TBool )
IMPORT_C void	SetPowerSetting ( TUint8 )
IMPORT_C void	SetScanEnable ( THCIScanEnable )

Protected Member Enumerations
enum	anonymous { EAddress = 0x0001, ECoD = 0x0002, EDeviceName = 0x0004, EPowerSetting = 0x0008, EScanEnable = 0x0010, ELimitedDiscoverable = 0x0020, EAFHChannelAssessmentMode = 0x0040, EAcceptPairedOnlyMode = 0x0080 }

Private Member Enumerations
enum	anonymous { EAFHChannelAssessmentModeValue = 0x0001, EAcceptPairedOnlyModeValue = 0x0002 }

Private Attributes
TBTDevAddr	iAddress
TUint32	iCod
TBool	iLimitedDiscoverable
TBTDeviceName8	iLocalName
TUint8	iPowerSetting
THCIScanEnable	iScanEnable
TUint	iSetMask
TUint32	iSimpleSettings

Constructor & Destructor Documentation

TBTLocalDevice()

IMPORT_C

TBTLocalDevice

(

)

Constructor

Member Functions Documentation

AFHChannelAssessmentMode()

IMPORT_C TBool

AFHChannelAssessmentMode

(

)

const

Get the AFH channel assessment mode.

AcceptPairedOnlyMode()

IMPORT_C TBool

AcceptPairedOnlyMode

(

)

const

Get the setting for whether to accept all incoming connections or just those from paired devices. Note this is in fact a setting in the stack not the controller.

Address()

IMPORT_C const TBTDevAddr &

Address

(

)

const

Get the address of the local device.

DeviceClass()

IMPORT_C TUint32

DeviceClass

(

)

const

Get the device class. TBTDeviceClass constructor

DeviceName()

IMPORT_C const TDesC8 &

DeviceName

(

)

const

Get the device name.

IsValidAFHChannelAssessmentMode()

IMPORT_C TBool

IsValidAFHChannelAssessmentMode

(

)

const

Denotes whether the AFH channel assessment mode has been set.

IsValidAcceptPairedOnlyMode()

IMPORT_C TBool

IsValidAcceptPairedOnlyMode

(

)

const

Denotes whether "Accept Paired Only Mode" has been set.

IsValidAddress()

IMPORT_C TBool

IsValidAddress

(

)

const

Denotes whether the address has been set.

IsValidDeviceClass()

IMPORT_C TBool

IsValidDeviceClass

(

)

const

Denotes whether the device class has been set.

IsValidDeviceName()

IMPORT_C TBool

IsValidDeviceName

(

)

const

Denotes whether the device name has been set.

IsValidLimitedDiscoverable()

IMPORT_C TBool

IsValidLimitedDiscoverable

(

)

const

Denotes whether the limited discoverable mode has been set.

IsValidPowerSetting()

IMPORT_C TBool

IsValidPowerSetting

(

)

const

Denotes whether the power setting has been set.

IsValidScanEnable()

IMPORT_C TBool

IsValidScanEnable

(

)

const

Denotes whether the scan enable has been set.

LimitedDiscoverable()

IMPORT_C TBool

LimitedDiscoverable

(

)

const

Get the limited discoverable mode.

PowerSetting()

IMPORT_C TUint8

PowerSetting

(

)

const

Get the power setting.

ScanEnable()

IMPORT_C THCIScanEnable

ScanEnable

(

)

const

Get the scanning mode.

SetAFHChannelAssessmentMode(TBool)

IMPORT_C void

SetAFHChannelAssessmentMode

(

TBool

aOn

)

Set the AFH channel assessment mode.

Parameters

TBool aOn

the local device channel assessment mode is switched on (available for use)

SetAcceptPairedOnlyMode(TBool)

IMPORT_C void

SetAcceptPairedOnlyMode

(

TBool

aOn

)

Set the paired device only mode. This is a stack setting which makes the decision as to whether to accept connection requests ONLY from paired devices (rejecting connection requests from unpaired devices).

Parameters

TBool aOn

the local stack will ONLY accept connection requests from paired devices

SetAddress(const TBTDevAddr &)

IMPORT_C void

SetAddress

(

const TBTDevAddr &

aAddr

)

Set the device address.

Parameters

const TBTDevAddr & aAddr

the local device address

SetDeviceClass(TUint32)

IMPORT_C void

SetDeviceClass

(

TUint32

aCod

)

Set the device class.

Parameters

TUint32 aCod

the local device class

SetDeviceName(const TDesC8 &)

IMPORT_C void

SetDeviceName

(

const TDesC8 &

aName

)

Set the device name.

Parameters

const TDesC8 & aName

the local device name

SetLimitedDiscoverable(TBool)

IMPORT_C void

SetLimitedDiscoverable

(

TBool

aOn

)

Set limited discoverable mode.

Parameters

TBool aOn

the local device limited discoverable-ness

SetPowerSetting(TUint8)

IMPORT_C void

SetPowerSetting

(

TUint8

aPowerSetting

)

Set the power setting.

Parameters

TUint8 aPowerSetting

the local device power setting

SetScanEnable(THCIScanEnable)

IMPORT_C void

SetScanEnable

(

THCIScanEnable

aEnable

)

Enable local device scanning.

Parameters

THCIScanEnable aEnable

the local device scanning

Member Enumerations Documentation

Enum anonymous

Enumerators

EAddress = 0x0001
ECoD = 0x0002
EDeviceName = 0x0004
EPowerSetting = 0x0008
EScanEnable = 0x0010
ELimitedDiscoverable = 0x0020
EAFHChannelAssessmentMode = 0x0040
EAcceptPairedOnlyMode = 0x0080