Collapse all Symbian^3 Product Developer Library

TBTNamelessDevice Class Reference

class TBTNamelessDevice

Stores parameters for a nameless device.

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

Nested Classes and Structures

TBTNamelessDevice::TBTBasebandParameters

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 &)

Public Member Enumerations
enum	TBTDeviceSet { EAddress = 0x000001, EDeviceClass = 0x000002, ELinkKey = 0x000004, EGlobalSecurity = 0x000008, EPageScanRepMode = 0x000010, EPageScanMode = 0x000020, EPageScanPeriodMode = 0x000040, EClockOffset = 0x000080, EUsed = 0x000100, ESeen = 0x000200, EIsPaired = 0x000400, EPassKey = 0x000800, EUiCookie = 0x001000, EAllNamelessProperties = 0x00ffffff }

Private Attributes
TBTDevAddr	iBDAddr
TBTBasebandParameters	iBasebandParams
TBTDeviceClass	iDeviceClass
TBTDeviceSecurity	iGlobalSecurity
TBTLinkKey	iLinkKey
TBTLinkKeyType	iLinkKeyType
TUint32	iPadding3
TUint32	iPadding4
TBool	iPaired
TBTPinCode	iPassKey
TTime	iSeen
TUint32	iSetMask
TUint32	iUiCookie
TTime	iUsed

Constructor & Destructor Documentation

TBTNamelessDevice()

IMPORT_C

TBTNamelessDevice

(

)

Constructor.

Member Functions Documentation

Address()

IMPORT_C const TBTDevAddr &

Address

(

)

const

Get the device address.

ClockOffset()

IMPORT_C TUint16

ClockOffset

(

)

const

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. TBTDeviceSet

Parameters

const TBTNamelessDevice & aDevice

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

GlobalSecurity()

IMPORT_C const TBTDeviceSecurity &

GlobalSecurity

(

)

const

Retrieve the global security settings.

IsPaired()

IMPORT_C TBool

IsPaired

(

)

const

Check whether the device is paired

IsValidAddress()

IMPORT_C TBool

IsValidAddress

(

)

const

Denotes whether the device address has been set.

IsValidClockOffset()

IMPORT_C TBool

IsValidClockOffset

(

)

const

Denotes whether the clock offset has been set.

IsValidDeviceClass()

IMPORT_C TBool

IsValidDeviceClass

(

)

const

Denotes whether the device class has been set.

IsValidGlobalSecurity()

IMPORT_C TBool

IsValidGlobalSecurity

(

)

const

Denotes whether the global security settings have been set.

IsValidLinkKey()

IMPORT_C TBool

IsValidLinkKey

(

)

const

Denotes whether the link key has been set.

IsValidPageScanMode()

IMPORT_C TBool

IsValidPageScanMode

(

)

const

Denotes whether the page scan mode has been set.

IsValidPageScanPeriodMode()

IMPORT_C TBool

IsValidPageScanPeriodMode

(

)

const

Denotes whether the page scan period mode has been set.

IsValidPageScanRepMode()

IMPORT_C TBool

IsValidPageScanRepMode

(

)

const

Denotes whether the page scan repition mode has been set.

IsValidPaired()

IMPORT_C TBool

IsValidPaired

(

)

const

Denote whether is paired has been set

IsValidPassKey()

IMPORT_C TBool

IsValidPassKey

(

)

const

Denotes whether the PassKey has been set.

IsValidSeen()

IMPORT_C TBool

IsValidSeen

(

)

const

Denotes whether the time last seen has been set.

IsValidUiCookie()

IMPORT_C TBool

IsValidUiCookie

(

)

const

Denotes whether the UI Cookie has been set.

IsValidUsed()

IMPORT_C TBool

IsValidUsed

(

)

const

Denotes whether the time last used has been set.

LinkKey()

IMPORT_C const TBTLinkKey &

LinkKey

(

)

const

Return the link key.

LinkKeyType()

IMPORT_C TBTLinkKeyType

LinkKeyType

(

)

const

Return the link key type.

PageScanMode()

IMPORT_C TUint8

PageScanMode

(

)

const

PageScanPeriodMode()

IMPORT_C TUint8

PageScanPeriodMode

(

)

const

PageScanRepMode()

IMPORT_C TUint8

PageScanRepMode

(

)

const

PassKey()

IMPORT_C const TBTPinCode &

PassKey

(

)

const

Return the PIN code.

PassKeyLength()

IMPORT_C TUint

PassKeyLength

(

)

const

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.

SetAddress(const TBTDevAddr &)

IMPORT_C void

SetAddress

(

const TBTDevAddr &

aBDAddr

)

Set the bluetooth device address.

Parameters

const TBTDevAddr & aBDAddr

the address of the device

SetClockOffset(TUint16)

IMPORT_C void

SetClockOffset

(

TUint16

aClockOffSet

)

Set the clock offset.

Parameters

TUint16 aClockOffSet

the clockoffset for the device

SetDeviceClass(TBTDeviceClass)

IMPORT_C void

SetDeviceClass

(

TBTDeviceClass

aDeviceClass

)

Set the device class.

Parameters

TBTDeviceClass 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

Parameters

const TBTDeviceSecurity & aSetting

the security override of the device

SetLinkKey(const TBTLinkKey &)

IMPORT_C void

SetLinkKey

(

const TBTLinkKey &

aLinkKey

)

Set the link key.

Parameters

const TBTLinkKey & aLinkKey

SetLinkKey(const TBTLinkKey &, TBTLinkKeyType)

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

Set the link key.

Parameters

const TBTLinkKey & aLinkKey
TBTLinkKeyType aLinkKeyType	the link key type of the device

SetPageScanMode(TUint8)

IMPORT_C void

SetPageScanMode

(

TUint8

aPageScanMode

)

Set the page scan mode.

Parameters

TUint8 aPageScanMode

the PSM of the device

SetPageScanPeriodMode(TUint8)

IMPORT_C void

SetPageScanPeriodMode

(

TUint8

aPageScanPeriodMode

)

Set the page scan period mode.

Parameters

TUint8 aPageScanPeriodMode

the PSPM of the device

SetPageScanRepMode(TUint8)

IMPORT_C void

SetPageScanRepMode

(

TUint8

aPageScanRepMode

)

Set the page scan repetition mode.

Parameters

TUint8 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. TBTNamelessDevice::SetPaired(TBTLinkKeyType aLinkKeyType)

Parameters

TBool aPaired

whether the device is paired

SetPaired(TBTLinkKeyType)

IMPORT_C void

SetPaired

(

TBTLinkKeyType

aLinkKeyType

)

Set the link key type because the device is paired

Parameters

TBTLinkKeyType aLinkKeyType

the link key type

SetPassKey(const TBTPinCode &)

IMPORT_C void

SetPassKey

(

const TBTPinCode &

aPassKey

)

Set PIN code for device

Parameters

const TBTPinCode & 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)

Parameters

const TTime & 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.

Parameters

TUint32 aUiCookie

The 32bit cookie value.

SetUsed(const TTime &)

IMPORT_C void

SetUsed

(

const TTime &

aDateTime

)

Set when the device last connected from or to.

Parameters

const TTime & 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.

Update(const TBTNamelessDevice &)

IMPORT_C void

Update

(

const TBTNamelessDevice &

aDevice

)

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

Parameters

const TBTNamelessDevice & 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.

operator!=(const TBTNamelessDevice &)

IMPORT_C TBool

operator!=

(

const TBTNamelessDevice &

aDevice

)

const

Compare aDevice with this.

Parameters

const TBTNamelessDevice & aDevice

The device to compare with this.

operator=(const TBTNamelessDevice &)

IMPORT_C TBTNamelessDevice &

operator=

(

const TBTNamelessDevice &

aDevice

)

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

Parameters

const TBTNamelessDevice & aDevice

The device to copy.

operator==(const TBTNamelessDevice &)

IMPORT_C TBool

operator==

(

const TBTNamelessDevice &

aDevice

)

const

Compare aDevice with this.

Parameters

const TBTNamelessDevice & aDevice

The device to compare with this.

Member Enumerations Documentation

Enum TBTDeviceSet

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

Enumerators

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

Member Data Documentation

TBTDevAddr iBDAddr

TBTDevAddr

iBDAddr

[private]

The BT address of the remote device

TBTBasebandParameters iBasebandParams

TBTBasebandParameters

iBasebandParams

[private]

The baseband parameters

TBTDeviceClass iDeviceClass

TBTDeviceClass

iDeviceClass

[private]

The class(es) of the remote device

TBTDeviceSecurity iGlobalSecurity

TBTDeviceSecurity

iGlobalSecurity

[private]

The overall security criteria for all services which this device may wish to use

TBTLinkKey iLinkKey

TBTLinkKey

iLinkKey

[private]

The link key

TBTLinkKeyType iLinkKeyType

TBTLinkKeyType

iLinkKeyType

[private]

Link Key Type

TUint32 iPadding3

TUint32

iPadding3

[private]

TUint32 iPadding4

TUint32

iPadding4

[private]

TBool iPaired

TBool

iPaired

[private]

Whether this device is paired

TBTPinCode iPassKey

TBTPinCode

iPassKey

[private]

PassKey

TTime iSeen

TTime

iSeen

[private]

when last seen in inquiry

TUint32 iSetMask

TUint32

iSetMask

[private]

Bit mask indicating the data members that have been set

TUint32 iUiCookie

TUint32

iUiCookie

[private]

The cookie attached to this device by the UI

TTime iUsed

TTime

iUsed

[private]

when last connect from/to