TBTNamelessDevice Class Reference

#include <btdevice.h>

Link against: btdevice.lib

class TBTNamelessDevice

Public Member Enumerations
enum	TBTDeviceSet { EAddress, EDeviceClass, ELinkKey, EGlobalSecurity, ..., EAllNamelessProperties }

Public Member Functions
	TBTNamelessDevice()
IMPORT_C const TBTDevAddr &	Address()
IMPORT_C TUint16	ClockOffset()
IMPORT_C TUint	CompareTo(const TBTNamelessDevice &)
IMPORT_C void	DeleteLinkKey()
IMPORT_C const TBTDeviceClass &	DeviceClass()
IMPORT_C const TBTDeviceSecurity &	GlobalSecurity()
IMPORT_C TBool	IsPaired()
IMPORT_C TBool	IsValidAddress()
IMPORT_C TBool	IsValidClockOffset()
IMPORT_C TBool	IsValidDeviceClass()
IMPORT_C TBool	IsValidGlobalSecurity()
IMPORT_C TBool	IsValidLinkKey()
IMPORT_C TBool	IsValidPageScanMode()
IMPORT_C TBool	IsValidPageScanPeriodMode()
IMPORT_C TBool	IsValidPageScanRepMode()
IMPORT_C TBool	IsValidPaired()
IMPORT_C TBool	IsValidPassKey()
IMPORT_C TBool	IsValidSeen()
IMPORT_C TBool	IsValidUiCookie()
IMPORT_C TBool	IsValidUsed()
IMPORT_C const TBTLinkKey &	LinkKey()
IMPORT_C TBTLinkKeyType	LinkKeyType()
IMPORT_C TUint8	PageScanMode()
IMPORT_C TUint8	PageScanPeriodMode()
IMPORT_C TUint8	PageScanRepMode()
IMPORT_C const TBTPinCode &	PassKey()
IMPORT_C TUint	PassKeyLength()
IMPORT_C const TTime &	Seen()
IMPORT_C void	SetAddress(const TBTDevAddr &)
IMPORT_C void	SetClockOffset(TUint16)
IMPORT_C void	SetDeviceClass(TBTDeviceClass)
IMPORT_C void	SetGlobalSecurity(const TBTDeviceSecurity &)
IMPORT_C void	SetLinkKey(const TBTLinkKey &)
IMPORT_C void	SetLinkKey(const TBTLinkKey &, TBTLinkKeyType)
IMPORT_C void	SetPageScanMode(TUint8)
IMPORT_C void	SetPageScanPeriodMode(TUint8)
IMPORT_C void	SetPageScanRepMode(TUint8)
IMPORT_C void	SetPaired(TBool)
IMPORT_C void	SetPaired(TBTLinkKeyType)
IMPORT_C void	SetPassKey(const TBTPinCode &)
IMPORT_C void	SetSeen(const TTime &)
IMPORT_C void	SetUiCookie(TUint32)
IMPORT_C void	SetUsed(const TTime &)
IMPORT_C TUint32	UiCookie()
IMPORT_C void	Update(const TBTNamelessDevice &)
IMPORT_C const TTime &	Used()
IMPORT_C TBool	operator!=(const TBTNamelessDevice &)
IMPORT_C TBTNamelessDevice &	operator=(const TBTNamelessDevice &)
IMPORT_C TBool	operator==(const TBTNamelessDevice &)

Detailed Description

Stores parameters for a nameless device.

A class which stores useful parameters concerning a remote device But *not* including names

Member Enumeration Documentation

Enum TBTDeviceSet

Bitfield of TBTNamelessDevice attributes This enum is to only be used by phone manufacturers, not by application developers.

Enumerator	Value	Description
EAddress	0x000001	Device address
EDeviceClass	0x000002	Device class
ELinkKey	0x000004	Link key
EGlobalSecurity	0x000008	Global security settings
EPageScanRepMode	0x000010	Page scan repition mode
EPageScanMode	0x000020	Page scan mode
EPageScanPeriodMode	0x000040	Page scan period
EClockOffset	0x000080	Clock offset
EUsed	0x000100	Last used
ESeen	0x000200	Last seen
EIsPaired	0x000400	Is paired
EPassKey	0x000800	PassKey
EUiCookie	0x001000	User interface specific cookie
EAllNamelessProperties	0x00ffffff	All nameless properties set

Constructor & Destructor Documentation

TBTNamelessDevice ( )

IMPORT_C

TBTNamelessDevice

(

)

Constructor.

Member Function Documentation

Address ( )

IMPORT_C const TBTDevAddr &

Address

(

)

const

Get the device address.

Returns: The device address this refers to

ClockOffset ( )

IMPORT_C TUint16

ClockOffset

(

)

const

Returns: the ClockOffSet of the device

CompareTo ( const TBTNamelessDevice & )

IMPORT_C TUint

CompareTo

(

const TBTNamelessDevice &

aDevice

)

const

Compare the attributes of aDevice to *this and return a bitfield of matching attributes.

DeleteLinkKey ( )

IMPORT_C void

DeleteLinkKey

(

)

Ensure that the previously known link key is discarded

DeviceClass ( )

IMPORT_C const TBTDeviceClass &

DeviceClass

(

)

const

Returns the class of the device

Returns: The device class.

GlobalSecurity ( )

IMPORT_C const TBTDeviceSecurity &

GlobalSecurity

(

)

const

Retrieve the global security settings.

Returns: The Global security settings for all services used by this device

IsPaired ( )

IMPORT_C TBool

IsPaired

(

)

const

Check whether the device is paired

Returns: ETrue = Paired

IsValidAddress ( )

IMPORT_C TBool

IsValidAddress

(

)

const

Denotes whether the device address has been set.

Returns: ETrue = The address of the device been set

IsValidClockOffset ( )

IMPORT_C TBool

IsValidClockOffset

(

)

const

Denotes whether the clock offset has been set.

Returns: ETrue = The clockoffset of the device been set

IsValidDeviceClass ( )

IMPORT_C TBool

IsValidDeviceClass

(

)

const

Denotes whether the device class has been set.

Returns: ETrue = The class of the device been set

IsValidGlobalSecurity ( )

IMPORT_C TBool

IsValidGlobalSecurity

(

)

const

Denotes whether the global security settings have been set.

Returns: ETrue = The global security settings of the device been set

IsValidLinkKey ( )

IMPORT_C TBool

IsValidLinkKey

(

)

const

Denotes whether the link key has been set.

Returns: ETrue = The link key of the device been set

IsValidPageScanMode ( )

IMPORT_C TBool

IsValidPageScanMode

(

)

const

Denotes whether the page scan mode has been set.

Returns: ETrue = The pagescanmode of the device been set

IsValidPageScanPeriodMode ( )

IMPORT_C TBool

IsValidPageScanPeriodMode

(

)

const

Denotes whether the page scan period mode has been set.

Returns: ETrue = The pagescanperiodmode of the device been set

IsValidPageScanRepMode ( )

IMPORT_C TBool

IsValidPageScanRepMode

(

)

const

Denotes whether the page scan repition mode has been set.

Returns: ETrue = The pagescanrepetitionmode of the device been set

IsValidPaired ( )

IMPORT_C TBool

IsValidPaired

(

)

const

Denote whether is paired has been set

Returns: Etrue = whether is paired has been set

IsValidPassKey ( )

IMPORT_C TBool

IsValidPassKey

(

)

const

Denotes whether the PassKey has been set.

Returns: ETrue = The PassKey of the device been set

IsValidSeen ( )

IMPORT_C TBool

IsValidSeen

(

)

const

Denotes whether the time last seen has been set.

Returns: ETrue = The time last seen has been set

IsValidUiCookie ( )

IMPORT_C TBool

IsValidUiCookie

(

)

const

Denotes whether the UI Cookie has been set.

Returns: ETrue = The UI Cookie for the device been set

IsValidUsed ( )

IMPORT_C TBool

IsValidUsed

(

)

const

Denotes whether the time last used has been set.

Returns: ETrue = The time last used has been set

LinkKey ( )

IMPORT_C const TBTLinkKey &

LinkKey

(

)

const

Return the link key.

Returns: the link key

LinkKeyType ( )

IMPORT_C TBTLinkKeyType

LinkKeyType

(

)

const

Return the link key type.

Returns: the link key type

PageScanMode ( )

IMPORT_C TUint8

PageScanMode

(

)

const

Returns: The Page Scan Mode of the device

PageScanPeriodMode ( )

IMPORT_C TUint8

PageScanPeriodMode

(

)

const

Returns: the Page Scan Period Mode of the device

PageScanRepMode ( )

IMPORT_C TUint8

PageScanRepMode

(

)

const

Returns: The Page Scan Repitition Mode of the device

PassKey ( )

IMPORT_C const TBTPinCode &

PassKey

(

)

const

Return the PIN code.

Returns: TBTPinCode

PassKeyLength ( )

IMPORT_C TUint

PassKeyLength

(

)

const

Returns: the PassKey length

Seen ( )

IMPORT_C const TTime &

Seen

(

)

const

Return the time when this device was last seen. Note that this is currently not support by the bluetooth stack. Only the time when the device was last _used_ can is stored.

Returns: TTime of when device last seen

SetAddress ( const TBTDevAddr & )

IMPORT_C void

SetAddress

(

const TBTDevAddr &

aBDAddr

)

Set the bluetooth device address.

Parameter	Description
aBDAddr	the address of the device

SetClockOffset ( TUint16 )

IMPORT_C void

SetClockOffset

(

TUint16

aClockOffSet

)

Set the clock offset.

Parameter	Description
aClockOffSet	the clockoffset for the device

SetDeviceClass ( TBTDeviceClass )

IMPORT_C void

SetDeviceClass

(

TBTDeviceClass

aDeviceClass

)

Set the device class.

Parameter	Description
aDeviceClass	the deviceclass of the device

SetGlobalSecurity ( const TBTDeviceSecurity & )

IMPORT_C void

SetGlobalSecurity

(

const TBTDeviceSecurity &

aSetting

)

Set the Global security settings for all services used by this device

Parameter	Description
aSetting	the security override of the device

SetLinkKey ( const TBTLinkKey & )

IMPORT_C void

SetLinkKey

(

const TBTLinkKey &

aLinkKey

)

Set the link key.

SetLinkKey ( const TBTLinkKey &, TBTLinkKeyType )

IMPORT_C void	SetLinkKey	(	const TBTLinkKey &	aLinkKey,
			TBTLinkKeyType	aLinkKeyType
		)

Set the link key.

Parameter	Description
aLinkKeyType	the link key type of the device

SetPageScanMode ( TUint8 )

IMPORT_C void

SetPageScanMode

(

TUint8

aPageScanMode

)

Set the page scan mode.

Parameter	Description
aPageScanMode	the PSM of the device

SetPageScanPeriodMode ( TUint8 )

IMPORT_C void

SetPageScanPeriodMode

(

TUint8

aPageScanPeriodMode

)

Set the page scan period mode.

Parameter	Description
aPageScanPeriodMode	the PSPM of the device

SetPageScanRepMode ( TUint8 )

IMPORT_C void

SetPageScanRepMode

(

TUint8

aPageScanRepMode

)

Set the page scan repetition mode.

Parameter	Description
aPageScanRepMode	the PSRM of the device

SetPaired ( TBool )

IMPORT_C void

SetPaired

(

TBool

aPaired

)

Set whether the device is paired. This function should not be used any more, instead the overload with a link key type should be used.

Parameter	Description
aPaired	whether the device is paired

SetPaired ( TBTLinkKeyType )

IMPORT_C void

SetPaired

(

TBTLinkKeyType

aLinkKeyType

)

Set the link key type because the device is paired

Parameter	Description
aLinkKeyType	the link key type

SetPassKey ( const TBTPinCode & )

IMPORT_C void

SetPassKey

(

const TBTPinCode &

aPassKey

)

Set PIN code for device

Parameter	Description
aPassKey	used for pairing

SetSeen ( const TTime & )

IMPORT_C void

SetSeen

(

const TTime &

aDateTime

)

Set when last seen in inquiry (not supported by stack at present)

Parameter	Description
aDateTime	The date/time stamp.

SetUiCookie ( TUint32 )

IMPORT_C void

SetUiCookie

(

TUint32

aUiCookie

)

Sets the UI Cookie for the device. The format of the cookie is specific to the UI using the field.

Parameter	Description
aUiCookie	The 32bit cookie value.

SetUsed ( const TTime & )

IMPORT_C void

SetUsed

(

const TTime &

aDateTime

)

Set when the device last connected from or to.

Parameter	Description
aDateTime	The date/time stamp.

UiCookie ( )

IMPORT_C TUint32

UiCookie

(

)

const

Returns the UI Cookie value associated with the device. The format of the cookie is specific to the UI using the field.

Returns: The 32bit cookie value.

Update ( const TBTNamelessDevice & )

IMPORT_C void

Update

(

const TBTNamelessDevice &

aDevice

)

Update 'this' with valid details of aDevice, leaving already present settings

Parameter	Description
aDevice	The device details to be used to update this device.

Used ( )

IMPORT_C const TTime &

Used

(

)

const

Return the time when the device was last used.

Returns: TTime of when device last connected to

operator!= ( const TBTNamelessDevice & )

IMPORT_C TBool

operator!=

(

const TBTNamelessDevice &

aDevice

)

const

Compare aDevice with this.

Parameter	Description
aDevice	The device to compare with this.

Returns: EFalse if they match, ETrue if not.

operator= ( const TBTNamelessDevice & )

IMPORT_C TBTNamelessDevice &

operator=

(

const TBTNamelessDevice &

aDevice

)

Compiler generated operator= is ok for this class, but ARM compiler warns

Parameter	Description
aDevice	The device to copy.

Returns: this Nameless Device

operator== ( const TBTNamelessDevice & )

IMPORT_C TBool

operator==

(

const TBTNamelessDevice &

aDevice

)

const

Compare aDevice with this.

Parameter	Description
aDevice	The device to compare with this.

Returns: ETrue if they match, EFalse if not.