takashi kadono / Mbed OS Nucleo_446

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.

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

link_encryption_t Struct Reference
Public Types | Public Member Functions | Friends

link_encryption_t Struct Reference

Type that describes link's encryption state. More...

#include <BLETypes.h>

Inherits SafeEnum< link_encryption_t, uint8_t >.

Public Types

enum  type {
  NOT_ENCRYPTED, ENCRYPTION_IN_PROGRESS, ENCRYPTED, ENCRYPTED_WITH_MITM,
  ENCRYPTED_WITH_SC_AND_MITM
}
 

struct scoped enum wrapped by the class

More...

Public Member Functions

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

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

Type that describes link's encryption state.

Definition at line 126 of file BLETypes.h.

Member Enumeration Documentation

enum type

struct scoped enum wrapped by the class

Enumerator:
NOT_ENCRYPTED 

The link is not secured.

ENCRYPTION_IN_PROGRESS 

Link security is being established.

ENCRYPTED 

The link is secure.

ENCRYPTED_WITH_MITM 

The link is secure and authenticated.

ENCRYPTED_WITH_SC_AND_MITM 

The link is secure and authenticated with a secure connection key.

Definition at line 128 of file BLETypes.h.

Constructor & Destructor Documentation

link_encryption_t ( type  value )

Construct a new instance of link_encryption_t.

Definition at line 139 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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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< link_encryption_t, uint8_t >  lhs,
SafeEnum< link_encryption_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.

Generated on Tue Aug 9 2022 00:37:37 by  doxygen 1.7.2