Rtos API example

Embed: (wiki syntax)

« Back to documentation index

own_address_type_t Struct Reference

own_address_type_t Struct Reference

Type used to model the own address used during the following GAP operations: advertising, scanning and initiating. More...

#include <GapTypes.h>

Inherits SafeEnum< own_address_type_t, uint8_t >.

Public Types

enum  type { PUBLIC_ADDRESS = 0x00, RANDOM_ADDRESS = 0x01, RESOLVABLE_PRIVATE_ADDRESS_PUBLIC_FALLBACK = 0x02, RESOLVABLE_PRIVATE_ADDRESS_RANDOM_FALLBACK = 0x03 }

Public Member Functions

 own_address_type_t (type value)
 Construct a new instance of own_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 used to model the own address used during the following GAP operations: advertising, scanning and initiating.

Definition at line 70 of file GapTypes.h.


Member Enumeration Documentation

enum type
Enumerator:
PUBLIC_ADDRESS 

Use the public device address.

RANDOM_ADDRESS 

Use the random device address.

RESOLVABLE_PRIVATE_ADDRESS_PUBLIC_FALLBACK 

Generated resolvable private address based on the local IRK from the resolving list.

Use the public address if no entry match in the resolving list.

RESOLVABLE_PRIVATE_ADDRESS_RANDOM_FALLBACK 

Generated resolvable private address based on the local IRK from the resolving list.

Use the random address if no entry match in the resolving list.

Definition at line 71 of file GapTypes.h.


Constructor & Destructor Documentation

own_address_type_t ( type  value )

Construct a new instance of own_address_type_t.

Definition at line 100 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< own_address_type_t, uint8_t >  lhs,
SafeEnum< own_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< own_address_type_t, uint8_t >  lhs,
SafeEnum< own_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.