Rtos API example

Embed: (wiki syntax)

« Back to documentation index

advertising_filter_policy_t Struct Reference

advertising_filter_policy_t Struct Reference

Filter policy which can be used during advertising. More...

#include <GapTypes.h>

Inherits SafeEnum< advertising_filter_policy_t, uint8_t >.

Public Types

enum  type { NO_FILTER = 0x00, FILTER_SCAN_REQUESTS = 0x01, FILTER_CONNECTION_REQUEST = 0x02, FILTER_SCAN_AND_CONNECTION_REQUESTS = 0x03 }

Public Member Functions

 advertising_filter_policy_t (type value)
 Construct a new instance of advertising_filter_policy_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

Filter policy which can be used during advertising.

Definition at line 327 of file GapTypes.h.


Member Enumeration Documentation

enum type
Enumerator:
NO_FILTER 

Process connection and scan requests from all devices.

The whitelist is not used.

FILTER_SCAN_REQUESTS 

Process connection requests from all devices but filter out scan requests of devices which are not in the whitelist.

FILTER_CONNECTION_REQUEST 

Process scan requests from all devices but filter out connection requests of devices which are not in the whitelist.

FILTER_SCAN_AND_CONNECTION_REQUESTS 

Filter out scan or connection requests of devices which are not in the whitelist.

Definition at line 329 of file GapTypes.h.


Constructor & Destructor Documentation

Construct a new instance of advertising_filter_policy_t.

Definition at line 358 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_filter_policy_t, uint8_t >  lhs,
SafeEnum< advertising_filter_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< advertising_filter_policy_t, uint8_t >  lhs,
SafeEnum< advertising_filter_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.