Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions
advertising_type_t Struct Reference
Ble » Gap

Encapsulates the peripheral advertising modes. More...

#include <Types.h>

Inheritance diagram for advertising_type_t:
SafeEnum< advertising_type_t, uint8_t >

Public Types

typedef uint8_t representation_t
 Type of the representation. More...
 

Public Member Functions

 advertising_type_t (type value)
 Construct a new advertising_type_t value. More...
 
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance. More...
 
const uint8_t * storage () const
 Return a pointer to the inner storage. More...
 

Detailed Description

Encapsulates the peripheral advertising modes.

It determines how the device appears to other scanner and peripheral devices in the scanning range.

Definition at line 149 of file Types.h.

Member Typedef Documentation

typedef uint8_t representation_t
inherited

Type of the representation.

Definition at line 113 of file SafeEnum.h.

Member Enumeration Documentation

enum type

enumeration of advertising_type_t values

Enumerator
CONNECTABLE_UNDIRECTED 

Device is connectable, scannable and doesn't expect connection from a specific peer.

See also
Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1.
CONNECTABLE_DIRECTED 

Device is connectable and expects connection from a specific peer.

(3.75 ms or smaller Advertising Interval)

See also
Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.
SCANNABLE_UNDIRECTED 

Device is scannable but not connectable.

See also
Vol 6, Part B, Section 2.3.1.4.
NON_CONNECTABLE_UNDIRECTED 

Device is not connectable and not scannable.

See also
Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3.
CONNECTABLE_DIRECTED_LOW_DUTY 

Device is connectable and expects connection from a specific peer (sent at long user set intervals).

Definition at line 151 of file Types.h.

Constructor & Destructor Documentation

Construct a new advertising_type_t value.

Parameters
valueThe value of the advertising_type_t created.

Definition at line 201 of file Types.h.

Member Function Documentation

const uint8_t * storage ( ) const
inherited

Return a pointer to the inner storage.

Definition at line 209 of file SafeEnum.h.

uint8_t value ( ) const
inherited

Explicit access to the inner value of the SafeEnum instance.

Definition at line 202 of file SafeEnum.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.