Rtos API example

Embed: (wiki syntax)

« Back to documentation index

initiator_policy_t Struct Reference

initiator_policy_t Struct Reference

Filter policy which can be used during connection initiation. More...

#include <GapTypes.h>

Inherits SafeEnum< initiator_policy_t, uint8_t >.

Public Types

enum  type { NO_FILTER, USE_WHITE_LIST }

Public Member Functions

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

Filter policy which can be used during connection initiation.

Definition at line 395 of file GapTypes.h.


Member Enumeration Documentation

enum type
Enumerator:
NO_FILTER 

The whitelist is not used to determine which advertiser to connect to.

USE_WHITE_LIST 

Whitelist is used to determine which advertiser to connect to.

Definition at line 396 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< initiator_policy_t, uint8_t >  lhs,
SafeEnum< initiator_policy_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< initiator_policy_t, uint8_t >  lhs,
SafeEnum< initiator_policy_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.