Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

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...
typedef uint8_t representation_t
 Type of the representation.

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.
const uint8_t * storage () const
 Return a pointer to the inner storage.

Friends

bool operator== (link_encryption_tlhs, link_encryption_trhs)
 Equal to operator for Target instances.
bool operator!= (link_encryption_tlhs, link_encryption_trhs)
 Not equal to operator for Target instances.
bool operator< (link_encryption_tlhs, link_encryption_trhs)
 Less than operator for Target instances.
bool operator<= (link_encryption_tlhs, link_encryption_trhs)
 Less than or equal to operator for Target instances.
bool operator> (link_encryption_tlhs, link_encryption_trhs)
 Greater than operator for Target instances.
bool operator>= (link_encryption_tlhs, link_encryption_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Type that describes link's encryption state.

Definition at line 167 of file BLETypes.h.

Member Typedef Documentation

typedef uint8_t representation_t [inherited]

Type of the representation.

Definition at line 113 of file SafeEnum.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 169 of file BLETypes.h.

Constructor & Destructor Documentation

link_encryption_t ( type  value )

Construct a new instance of link_encryption_t.

Definition at line 180 of file BLETypes.h.

Member Function Documentation

const uint8_t * storage (  ) const [inherited]

Return a pointer to the inner storage.

Definition at line 209 of file SafeEnum.h.

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 202 of file SafeEnum.h.

Friends And Related Function Documentation

bool operator!= ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Not equal to operator for Target 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 144 of file SafeEnum.h.

bool operator< ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Less than operator for Target 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 156 of file SafeEnum.h.

bool operator<= ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Less than or equal to operator for Target 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 169 of file SafeEnum.h.

bool operator== ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Equal to operator for Target 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 131 of file SafeEnum.h.

bool operator> ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Greater than operator for Target 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 182 of file SafeEnum.h.

bool operator>= ( link_encryption_t  lhs,
link_encryption_t  rhs 
) [friend, inherited]

Greater than or equal to operator for Target 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 195 of file SafeEnum.h.

Generated on Tue Jul 12 2022 13:55:39 by  doxygen 1.7.2