Rtos API example

Embed: (wiki syntax)

« Back to documentation index

advertising_peer_address_type_t Struct Reference

advertising_peer_address_type_t Struct Reference

Type modeling the peer address type during direct advertising. More...

#include <GapTypes.h>

Inherits SafeEnum< advertising_peer_address_type_t, uint8_t >.

Public Types

enum  type { PUBLIC_ADDRESS = 0x00, RANDOM_ADDRESS = 0x01 }

Public Member Functions

 advertising_peer_address_type_t (type value)
 Construct a new instance of advertising_peer_address_type_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.

Detailed Description

Type modeling the peer address type during direct advertising.

Definition at line 108 of file GapTypes.h.


Member Enumeration Documentation

enum type
Enumerator:
PUBLIC_ADDRESS 

Public device address or identity address.

RANDOM_ADDRESS 

Random device address or random (static) identity address.

Definition at line 110 of file GapTypes.h.


Constructor & Destructor Documentation

Construct a new instance of advertising_peer_address_type_t.

Definition at line 125 of file GapTypes.h.


Member Function Documentation

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 145 of file SafeEnum.h.


Friends And Related Function Documentation

bool operator!= ( SafeEnum< advertising_peer_address_type_t, uint8_t >  lhs,
SafeEnum< advertising_peer_address_type_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< advertising_peer_address_type_t, uint8_t >  lhs,
SafeEnum< advertising_peer_address_type_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.