Mbed OS Reference
Loading...
Searching...
No Matches
link_encryption_t Struct Reference

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

#include <BLETypes.h>

Inheritance diagram for link_encryption_t:
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. More...
 

Public Member Functions

 link_encryption_t (type value)
 Construct a new instance of link_encryption_t. More...
 
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance. More...
 
const uint8_t * storage () const
 Return a pointer to the inner storage. More...
 

Detailed Description

Type that describes link's encryption state.

Definition at line 172 of file common/BLETypes.h.

Member Typedef Documentation

◆ representation_t

typedef uint8_t representation_t
inherited

Type of the representation.

Definition at line 115 of file common/SafeEnum.h.

Member Enumeration Documentation

◆ type

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 174 of file common/BLETypes.h.

Constructor & Destructor Documentation

◆ link_encryption_t()

link_encryption_t ( type  value)

Construct a new instance of link_encryption_t.

Definition at line 185 of file common/BLETypes.h.

Member Function Documentation

◆ value()

uint8_t value ( ) const
inherited

Explicit access to the inner value of the SafeEnum instance.

Definition at line 204 of file common/SafeEnum.h.

◆ storage()

const uint8_t * storage ( ) const
inherited

Return a pointer to the inner storage.

Definition at line 211 of file common/SafeEnum.h.