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

Type that describes a peer device address type. More...

#include <BLETypes.h>

Inheritance diagram for peer_address_type_t:
SafeEnum< peer_address_type_t, uint8_t >

Public Types

enum  type {
  PUBLIC = 0 , RANDOM , PUBLIC_IDENTITY , RANDOM_STATIC_IDENTITY ,
  ANONYMOUS = 0xFF
}
 struct scoped enum wrapped by the class More...
 
typedef uint8_t representation_t
 Type of the representation. More...
 

Public Member Functions

 peer_address_type_t (type value)
 Construct a new instance of peer_address_type_t. More...
 
 peer_address_type_t ()
 Default initialization of peer_address_type_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 a peer device address type.

Definition at line 591 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
PUBLIC 

Public device address.

RANDOM 

Random address.

Use Gap::getRandomAddressType to retrieve the type of the random address.

PUBLIC_IDENTITY 

A Public address used as a device identity address.

RANDOM_STATIC_IDENTITY 

A Random static address used as a device identity address.

ANONYMOUS 

No address provided (anonymous advertisement).

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

Constructor & Destructor Documentation

◆ peer_address_type_t() [1/2]

Construct a new instance of peer_address_type_t.

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

◆ peer_address_type_t() [2/2]

Default initialization of peer_address_type_t.

Definition at line 632 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.