Rtos API example

Embed: (wiki syntax)

« Back to documentation index

scanning_filter_policy_t Struct Reference

scanning_filter_policy_t Struct Reference

Filter policy which can be used during a scan. More...

#include <GapTypes.h>

Inherits SafeEnum< scanning_filter_policy_t, uint8_t >.

Public Types

enum  type { NO_FILTER = 0x00, FILTER_ADVERTISING = 0x01 }

Public Member Functions

 scanning_filter_policy_t (type value)
 Construct a new instance of scanning_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 a scan.

Definition at line 366 of file GapTypes.h.


Member Enumeration Documentation

enum type
Enumerator:
NO_FILTER 

Accept all advertising packets except directed advertising packet not addressed to this device.

FILTER_ADVERTISING 

Accept only advertising packets from devices in the whitelist except directed advertising packet not addressed to this device.

Definition at line 367 of file GapTypes.h.


Constructor & Destructor Documentation

Construct a new instance of scanning_filter_policy_t.

Definition at line 386 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< scanning_filter_policy_t, uint8_t >  lhs,
SafeEnum< scanning_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< scanning_filter_policy_t, uint8_t >  lhs,
SafeEnum< scanning_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.