Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: bt_sock.h
Link against: bluetooth.lib

Class TBTAccessRequirements

class TBTAccessRequirements;

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

Members

Defined in TBTAccessRequirements:
AuthenticationRequired(), AuthorisationRequired(), Denied(), EncryptionRequired(), PasskeyMinLength(), SetAuthentication(), SetAuthorisation(), SetDenied(), SetEncryption(), SetPasskeyMinLength(), TBTAccessRequirements(), operator==()


Construction and destruction


TBTAccessRequirements()

IMPORT_C TBTAccessRequirements();

Description

Constructor

[Top]


Member functions


SetAuthentication()

IMPORT_C void SetAuthentication(TBool aPreference);

Description

Sets the authentification requirement of this class.

Parameters

TBool aPreference

If true authentification is added to the requirements.


SetAuthorisation()

IMPORT_C void SetAuthorisation(TBool aPreference);

Description

Sets the authorisation requirement of this class.

Parameters

TBool aPreference

If true authorisation is added to the requirements.


SetEncryption()

IMPORT_C void SetEncryption(TBool aPreference);

Description

Sets the encryption requirement of this class.

Parameters

TBool aPreference

If true encryption is added to the requirements.


SetDenied()

IMPORT_C void SetDenied(TBool aPreference);

Description

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.


SetPasskeyMinLength()

IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);

Description

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

Return value

TInt


AuthenticationRequired()

IMPORT_C TBool AuthenticationRequired() const;

Description

Getter for the authentification attribute.

Return value

TBool

EAuthenticate if authentification is a required attribute, zero otherwise.


AuthorisationRequired()

IMPORT_C TBool AuthorisationRequired() const;

Description

Getter for the authorisation attribute.

Return value

TBool

EAuthorise if authorisation is a required attribute, zero otherwise.


EncryptionRequired()

IMPORT_C TBool EncryptionRequired() const;

Description

Getter for the encryption attribute.

Return value

TBool

EEncrypt if encryption is a required attribute, zero otherwise.


Denied()

IMPORT_C TBool Denied() const;

Description

Getter for the denied attribute.

Return value

TBool

EDenied if denied is a required attribute, zero otherwise.


PasskeyMinLength()

IMPORT_C TUint PasskeyMinLength() const;

Description

Getter for the minimal passkey length

Return value

TUint

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


operator==()

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

Description

Equals operator.

Parameters

const TBTAccessRequirements &aRequirements

The instance being compared.

Return value

TBool

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