Knight KE / Mbed OS Game_Master

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

att_security_requirement_t Struct Reference
Public Types | Public Member Functions | Static Public Attributes | Friends

att_security_requirement_t Struct Reference

Security requirement that can be attached to an attribute operation. More...

#include <BLETypes.h>

Inherits SafeEnum< att_security_requirement_t, uint8_t >.

Public Types

enum  type { NONE, UNAUTHENTICATED, AUTHENTICATED, SC_AUTHENTICATED }
 

struct scoped enum wrapped by the class

More...

Public Member Functions

 att_security_requirement_t (type value)
 Construct a new instance of att_security_requirement_t.
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance.

Static Public Attributes

static const uint8_t size = 2
 Number of bits required to store the value.

Friends

bool operator== (SafeEnum lhs, SafeEnum rhs)
 Equal to operator for SafeEnum instances.
bool operator!= (SafeEnum lhs, SafeEnum rhs)
 Not equal to operator for SafeEnum instances.
bool operator< (SafeEnum lhs, SafeEnum rhs)
 Less than operator for SafeEnum instances.
bool operator<= (SafeEnum lhs, SafeEnum rhs)
 Less than or equal to operator for SafeEnum instances.
bool operator> (SafeEnum lhs, SafeEnum rhs)
 Greater than operator for SafeEnum instances.
bool operator>= (SafeEnum lhs, SafeEnum rhs)
 Greater than or equal to operator for SafeEnum instances.

Detailed Description

Security requirement that can be attached to an attribute operation.

Definition at line 467 of file BLETypes.h.

Member Enumeration Documentation

enum type

struct scoped enum wrapped by the class

Enumerator:
NONE 

The operation does not have security requirements.

It is equivalent to: SecurityMode 1 level 1: No authentication, no encryption and no signing required.

Note:
This security mode is not applicable for signed operation.
Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK.
UNAUTHENTICATED 

The operation requires security and there's no requirement towards peer authentication.

Note:
Security can be achieved either by signing messages or encrypting the link.
Signing is only applicable for signed write operations.
Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM or SecurityManager::SECURITY_MODE_SIGNED_NO_MITM.
AUTHENTICATED 

The operation requires security and the peer must be authenticated.

Note:
Security can be achieved either by signing messages or encrypting the link.
Equivalent to SecurityManager::SECURITY_MODE_ENCRYPTION_WITH_MITM or SecurityManager::SECURITY_MODE_SIGNED_WITH_MITM.
SC_AUTHENTICATED 

The operation require encryption with an authenticated peer that paired using secure connection pairing.

Note:
This security mode is not applicable for signed operation; security is achieved with link encryption.

Definition at line 477 of file BLETypes.h.

Constructor & Destructor Documentation

att_security_requirement_t ( type  value )

Construct a new instance of att_security_requirement_t.

Definition at line 528 of file BLETypes.h.

Member Function Documentation

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 196 of file SafeEnum.h.

Friends And Related Function Documentation

bool operator!= ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Not equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are not equal and false otherwise.

Definition at line 138 of file SafeEnum.h.

bool operator< ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Less than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than rhs and false otherwise.

Definition at line 150 of file SafeEnum.h.

bool operator<= ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Less than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than or equal to rhs and false otherwise.

Definition at line 163 of file SafeEnum.h.

bool operator== ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are equal and false otherwise.

Definition at line 125 of file SafeEnum.h.

bool operator> ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Greater than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than rhs; false otherwise.

Definition at line 176 of file SafeEnum.h.

bool operator>= ( SafeEnum< att_security_requirement_t, uint8_t >  lhs,
SafeEnum< att_security_requirement_t, uint8_t >  rhs 
) [friend, inherited]

Greater than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than or equal to rhs; false otherwise.

Definition at line 189 of file SafeEnum.h.

Field Documentation

const uint8_t size = 2 [static]

Number of bits required to store the value.

This value can be used to define a bitfield that host a value of this enum.

Definition at line 474 of file BLETypes.h.

Generated on Tue Jul 12 2022 12:47:25 by  doxygen 1.7.2