#include <btdevice.h>
Link against:
btdevice.lib
class TBTDeviceSecurity;
Description
Class to store the security override parameters for a particular remote device.
Members
Defined in TBTDeviceSecurity:
Construction and destruction
IMPORT_C TBTDeviceSecurity();
Description
Constructor
TBTDeviceSecurity(TUint8)
IMPORT_C TBTDeviceSecurity(TUint8 aSecurity);
Description
Constructor with userdefined security
Parameters
TUint8 aSecurity |
bitfield describing security settings
|
|
See also:
TBTDeviceSecurity(TUint8,TUint)
IMPORT_C TBTDeviceSecurity(TUint8 aSecurity, TUint aPasskeyMinLength);
Description
Constructor with userdefined security
Parameters
TUint8 aSecurity |
bitfield describing security settings
|
TUint aPasskeyMinLength |
0..16
|
|
See also:
TBTDeviceSecurity(TBool,TBool,TBool,TBool)
IMPORT_C TBTDeviceSecurity(TBool aNoAuthenticate, TBool aNoAuthorise, TBool aEncrypt, TBool aBanned);
Description
Constructor with user-defined security
Parameters
TBool aNoAuthenticate |
Use ETrue if connections with this device should not be authenticated.
|
TBool aNoAuthorise |
Use ETrue if connections with this device should not be authorised - ie the device is trusted.
|
TBool aEncrypt |
Use ETrue if connections with this device should be encrypted
|
TBool aBanned |
Use ETrue if connections with this device should not be allowed
|
|
TBTDeviceSecurity(TMitmRequired,TBool,TBool,TBool)
IMPORT_C TBTDeviceSecurity(TMitmRequired aMitmRequirements, TBool aNoAuthorise, TBool aEncrypt, TBool aBanned);
Description
Constructor with user-defined security
Parameters
TBTDeviceSecurity::TMitmRequired aMitmRequirements |
Use TBTDeviceSecurity::EMitmRequired if connections with this device should require MITM protection.
|
TBool aNoAuthorise |
Use ETrue if connections with this device should not be authorised - ie the device is trusted.
|
TBool aEncrypt |
Use ETrue if connections with this device should be encrypted
|
TBool aBanned |
Use ETrue if connections with this device should not be allowed
|
|
IMPORT_C void SetNoAuthenticate(TBool aDecision);
Description
Set (no) authentication
Parameters
TBool aDecision |
ETrue=>don't authenticate, EFalse=>authenticate
|
|
SetMitmRequirements(TMitmRequired)
IMPORT_C void SetMitmRequirements(TMitmRequired aDecision);
Description
Specifies the man-in-the-middle requirements on a security service.
Parameters
TBTDeviceSecurity::TMitmRequired aDecision |
EMitmRequired if MITM protection is required for connections for a particular device, EMitmUnspecified otherwise to use the
default service requirements.
|
|
IMPORT_C void SetNoAuthorise(TBool aDecision);
Description
Set (no) authorisation (=make trusted)
Parameters
TBool aDecision |
ETrue=>don't authorise, EFalse=>authorise
|
|
IMPORT_C void SetEncrypt(TBool aDecision);
Description
Set encryption
Parameters
TBool aDecision |
ETrue=>encrypt, EFalse=>don't encrypt
|
|
IMPORT_C void SetBanned(TBool aDecision);
Description
Set banned
Parameters
TBool aDecision |
ETrue=>device is banned, EFalse=>device allowed
|
|
IMPORT_C TBool NoAuthenticate() const;
Description
Determine whether connections to this device should not be authenticated.
Return value
TBool
|
ETrue=>don't authenticate, EFalse=>authenticate
|
|
IMPORT_C TMitmRequired MitmRequirements() const;
Description
Determine whether connections to this device should have MITM protection.
Return value
IMPORT_C TBool NoAuthorise() const;
Description
Determine whether connections to this device should not be authorised.
Return value
TBool
|
ETrue=>don't authorise, EFalse=>authorisation
|
|
IMPORT_C TBool Encrypt() const;
Description
Determine whether connections to this device should be encrypted.
Return value
TBool
|
ETrue=>encrypt, EFalse=>don't encrypt
|
|
IMPORT_C TBool Banned() const;
Description
Determine whether connections to this device should be banned.
Return value
TBool
|
ETrue=>banned, EFalse=>not banned
|
|
IMPORT_C TUint PasskeyMinLength() const;
Description
Get passkey min length.
Return value
TUint
|
TUint passkey min length
|
|
IMPORT_C TUint8 SecurityValue() const;
Description
Get the raw security settings.
Return value
TUint8
|
8 bit unsigned value of security settings
|
|
IMPORT_C void SetSecurityValue(TUint8 aDeviceSecurity);
Description
Set the raw security settings.
Parameters
TUint8 aDeviceSecurity |
8 bit settings of security
|
|
SetPasskeyMinLength(TUint)
IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);
Description
Set passkey min length.
Parameters
Return value
operator==(const TBTDeviceSecurity &)const
IMPORT_C TBool operator==(const TBTDeviceSecurity &aDeviceSecurity) const;
Description
Comparison operator
Parameters
Return value
TBool
|
ETrue if instances equal
|
|
operator!=(const TBTDeviceSecurity &)const
IMPORT_C TBool operator!=(const TBTDeviceSecurity &aDeviceSecurity) const;
Description
Inequality operator
Parameters
Return value
TBool
|
ETrue if instances not equal
|
|
ExternalizeL(RWriteStream &)const
IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
Description
Externalise object.
Parameters
RWriteStream &aStream |
The stream to which the object shall be externalised.
|
|
Leave codes
This |
method will leave if an error occurs.
|
|
InternalizeL(RReadStream &)
IMPORT_C void InternalizeL(RReadStream &aStream);
Description
Internalise object.
Parameters
RReadStream &aStream |
The stream from which the object shall be internalised.
|
|
Leave codes
This |
method will leave if an error occurs.
|
|
TMitmRequired
Description
Enumeration to provide select MITM protection required.
Enum TBTDeviceSecuritySettings
TBTDeviceSecuritySettings
Description
Enumeration to assist in parsing of security settings.
![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)