TBTAccessRequirements Class Reference

#include <btsecurity.h>

Link against: bluetooth.lib

class TBTAccessRequirements

Detailed Description

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

Constructor & Destructor Documentation

TBTAccessRequirements ( )

IMPORT_CTBTAccessRequirements()

Constructor

Member Function Documentation

AuthenticationRequired ( )

IMPORT_C TBoolAuthenticationRequired()const

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

Returns: EAuthenticate if authentification is a required attribute, zero otherwise.

AuthorisationRequired ( )

IMPORT_C TBoolAuthorisationRequired()const

Getter for the authorisation attribute.

Returns: EAuthorise if authorisation is a required attribute, zero otherwise.

Denied ( )

IMPORT_C TBoolDenied()const

Getter for the denied attribute.

Returns: EDenied if denied is a required attribute, zero otherwise.

EncryptionRequired ( )

IMPORT_C TBoolEncryptionRequired()const

Getter for the encryption attribute.

Returns: EEncrypt if encryption is a required attribute, zero otherwise.

MitmProtection ( )

IMPORT_C TBluetoothMitmProtectionMitmProtection()const

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

Returns: The level of Man-in-the-Middle protection required for authentication.

PasskeyMinLength ( )

IMPORT_C TUintPasskeyMinLength()const

Getter for the minimal passkey length

Returns: 1..16 means set. 0 means - no requirement for minimal passkey length

SetAuthentication ( TBool )

IMPORT_C voidSetAuthentication(TBoolaPreference)

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

ParameterDescription
aPreferenceIf true authentification is added to the requirements.

SetAuthentication ( TBluetoothMitmProtection )

IMPORT_C voidSetAuthentication(TBluetoothMitmProtectionaPreference)

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

ParameterDescription
aPreferenceThe level of Man-in-the-Middle protection required for authentication.

SetAuthorisation ( TBool )

IMPORT_C voidSetAuthorisation(TBoolaPreference)

Sets the authorisation requirement of this class.

ParameterDescription
aPreferenceIf true authorisation is added to the requirements.

SetDenied ( TBool )

IMPORT_C voidSetDenied(TBoolaPreference)

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

ParameterDescription
aPreferenceIf true the denied attribute is added to the requirements.

SetEncryption ( TBool )

IMPORT_C voidSetEncryption(TBoolaPreference)

Sets the encryption requirement of this class.

ParameterDescription
aPreferenceIf true encryption is added to the requirements.

SetPasskeyMinLength ( TUint )

IMPORT_C TIntSetPasskeyMinLength(TUintaPasskeyMinLength)

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

ParameterDescription
aPasskeyMinLengthIf 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 TBooloperator==(const TBTAccessRequirements &aRequirements)const

Equals operator.

ParameterDescription
aRequirementsThe instance being compared.

Returns: True if the requirements specified in this instance match those of the instance passed in the argument.