Symbian^3 Application Developer Library >

TBTAccessRequirements Class Reference

class TBTAccessRequirements

The access requirements set up by a bluetooth service.

An incoming connection must satisfy these criteria before the connection may proceed. Not spectacularly useful for applications; mainly used by other Bluetooth libraries

Public Member Functions
TBTAccessRequirements ()
IMPORT_C TBool AuthenticationRequired ()
IMPORT_C TBool AuthorisationRequired ()
IMPORT_C TBool Denied ()
IMPORT_C TBool EncryptionRequired ()
IMPORT_C TBluetoothMitmProtection MitmProtection ()
IMPORT_C TUint PasskeyMinLength ()
IMPORT_C void SetAuthentication ( TBool )
IMPORT_C void SetAuthentication ( TBluetoothMitmProtection )
IMPORT_C void SetAuthorisation ( TBool )
IMPORT_C void SetDenied ( TBool )
IMPORT_C void SetEncryption ( TBool )
IMPORT_C TInt SetPasskeyMinLength ( TUint )
IMPORT_C TBool operator== (const TBTAccessRequirements &)
Private Member Enumerations
enum TBTAccessRequirementsMitmProtection { EAccessRequirementsMitmUndefined  = 0x00, EAccessRequirementsMitmNotRequired  = 0x10, EAccessRequirementsMitmDesired  = 0x20, EAccessRequirementsMitmRequired  = 0x30 }
enum TBTServiceSecuritySettings { EAuthenticate  = 0x01, EAuthorise  = 0x02, EEncrypt  = 0x04, EDenied  = 0x08, EMitm  = 0x30 }
Private Attributes
TUint iPasskeyMinLength
TUint8 iRequirements

Constructor & Destructor Documentation

TBTAccessRequirements()

IMPORT_C TBTAccessRequirements ( )

Constructor

Member Functions Documentation

AuthenticationRequired()

IMPORT_C TBool AuthenticationRequired ( ) const

Getter for the authentification attribute. The TBTAccessRequirements::MitmProtection function should be used instead.

AuthorisationRequired()

IMPORT_C TBool AuthorisationRequired ( ) const

Getter for the authorisation attribute.

Denied()

IMPORT_C TBool Denied ( ) const

Getter for the denied attribute.

EncryptionRequired()

IMPORT_C TBool EncryptionRequired ( ) const

Getter for the encryption attribute.

MitmProtection()

IMPORT_C TBluetoothMitmProtection MitmProtection ( ) const

Getter for the Man-in-the-Middle protection requirements.

PasskeyMinLength()

IMPORT_C TUint PasskeyMinLength ( ) const

Getter for the minimal passkey length

SetAuthentication(TBool)

IMPORT_C void SetAuthentication ( TBool aPreference )

Sets the authentication requirement of this class. The TBTAccessRequirements::SetAuthentication(TBluetoothMitmProtection) function should be used instead.

Parameters

TBool aPreference If true authentification is added to the requirements.

SetAuthentication(TBluetoothMitmProtection)

IMPORT_C void SetAuthentication ( TBluetoothMitmProtection aPreference )

Sets the Man-in-the-Middle requirements for authentication of this class.

Parameters

TBluetoothMitmProtection aPreference The level of Man-in-the-Middle protection required for authentication.

SetAuthorisation(TBool)

IMPORT_C void SetAuthorisation ( TBool aPreference )

Sets the authorisation requirement of this class.

Parameters

TBool aPreference If true authorisation is added to the requirements.

SetDenied(TBool)

IMPORT_C void SetDenied ( TBool aPreference )

Sets the denied requirement of this class. If this is set no connects will be accepted unless specified in the device overrides.

Parameters

TBool aPreference If true the denied attribute is added to the requirements.

SetEncryption(TBool)

IMPORT_C void SetEncryption ( TBool aPreference )

Sets the encryption requirement of this class.

Parameters

TBool aPreference If true encryption is added to the requirements.

SetPasskeyMinLength(TUint)

IMPORT_C TInt SetPasskeyMinLength ( TUint aPasskeyMinLength )

Sets the minimal length requrement for passkey If it is between 1..16 SecurityManager will check the length of passkey

Parameters

TUint aPasskeyMinLength If this is set to 0, means no minimal length requirement. 1..16 is the valid range. >16 Not valid, we set to 0

operator==(const TBTAccessRequirements &)

IMPORT_C TBool operator== ( const TBTAccessRequirements & aRequirements ) const

Equals operator.

Parameters

const TBTAccessRequirements & aRequirements The instance being compared.

Member Enumerations Documentation

Enum TBTAccessRequirementsMitmProtection

Enumerators

EAccessRequirementsMitmUndefined = 0x00
EAccessRequirementsMitmNotRequired = 0x10
EAccessRequirementsMitmDesired = 0x20
EAccessRequirementsMitmRequired = 0x30

Enum TBTServiceSecuritySettings

Enumerators

EAuthenticate = 0x01
EAuthorise = 0x02
EEncrypt = 0x04
EDenied = 0x08
EMitm = 0x30

Member Data Documentation

TUint iPasskeyMinLength

TUint iPasskeyMinLength [private]

TUint8 iRequirements

TUint8 iRequirements [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.