Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Typedefs
Gap

Data Structures

class  AdvertisingDataBuilder
 Build advertising data. More...
 
class  AdvertisingDataParser
 Parse and iterate over advertising data. More...
 
class  AdvertisingDataSimpleBuilder< DataSize >
 Build advertising data. More...
 
struct  adv_data_type_t
 
struct  adv_data_flags_t
 Set of advertising flags. More...
 
struct  adv_data_appearance_t
 Enumeration of values for the adv_data_type_t::APPEARANCE. More...
 
class  AdvertisingParameters
 Parameters defining the advertising process. More...
 
class  ConnectionParameters
 Parameters defining the connection initiation process. More...
 
struct  AdvertisingReportEvent
 Event generated when an advertising packet is seen during passive scanning or a scan response is received during active scanning. More...
 
struct  ConnectionCompleteEvent
 Event generated when a connection initiation ends (successfully or not). More...
 
struct  PeriodicAdvertisingSyncEstablishedEvent
 Event generated when you first receive a periodic advertisement. More...
 
struct  PeriodicAdvertisingReportEvent
 Event generated when periodic advertising packet is received. More...
 
struct  PeriodicAdvertisingSyncLoss
 Event generated when periodic advertising sync is lost. More...
 
struct  ScanTimeoutEvent
 Event generated when scan times out. More...
 
struct  AdvertisingEndEvent
 Event produced when advertising ends. More...
 
struct  ScanRequestEvent
 Event produced when a peer requests a scan response from the advertiser. More...
 
struct  DisconnectionCompleteEvent
 Event produced when a disconnection is complete. More...
 
struct  UpdateConnectionParametersRequestEvent
 Event received when a peer wants to change the connection parameters. More...
 
struct  ConnectionParametersUpdateCompleteEvent
 Event received when connection parameters have been updated. More...
 
class  Gap
 Define device discovery, connection and link management procedures. More...
 
class  ScanParameters
 Parameters defining the scan process. More...
 
struct  advertising_type_t
 Encapsulates the peripheral advertising modes. More...
 
struct  advertising_data_status_t
 Used to indicate if the packet is complete and if it's truncated. More...
 
struct  advertising_event_t
 Properties of an advertising event. More...
 
struct  advertising_filter_policy_t
 Advertising policy filter modes. More...
 
struct  scanning_filter_policy_t
 Scanning policy filter mode. More...
 
struct  initiator_filter_policy_t
 Filter policy that you can use during connection initiation. More...
 
struct  duplicates_filter_t
 Scanning policy filter mode. More...
 
struct  own_address_type_t
 Type used to model the own address used during the following GAP operations: advertising, scanning and initiating. More...
 
struct  target_peer_address_type_t
 Type of an address to connect to. More...
 
struct  clock_accuracy_t
 Accuracy of the master clock. More...
 
struct  connection_role_t
 Enumeration of GAP roles. More...
 
struct  local_disconnection_reason_t
 Enumeration of disconnection reasons that should be transmited to the peer. More...
 
struct  disconnection_reason_t
 Enumeration of disconnection reasons received in a disconnection event. More...
 
struct  peripheral_privacy_configuration_t
 Privacy Configuration of the peripheral role. More...
 
struct  central_privay_configuration_t
 Privacy configuration of the central role. More...
 
class  Gap
 Define device discovery, connection and link management procedures. More...
 
class  GapAdvertisingData
 GAP advertising data builder. More...
 
class  GapAdvertisingParams
 Parameters defining the advertising process. More...
 
class  GapScanningParams
 Parameters defining the scan process. More...
 

Typedefs

typedef Duration< uint32_t, 625, Range< 0x20, 0xFFFFFF > > adv_interval_t
 Time interval between two advertisements. More...
 
typedef Duration< uint16_t, 10000, Range< 0x00, 0xFFFF >, Value< uint16_t, 0x0000 > > adv_duration_t
 Advertising process duration. More...
 
typedef Duration< uint16_t, 10000, Range< 0x00, 0xFFFF >, Value< uint16_t, 0x0000 > > scan_duration_t
 Scan process duration. More...
 
typedef Duration< uint16_t, 1280000, Range< 0x00, 0xFFFF > > scan_period_t
 Time interval between two scan processes. More...
 
typedef Duration< uint16_t, 625, Range< 0x04, 0xFFFF > > scan_interval_t
 Time interval between two scans. More...
 
typedef Duration< uint16_t, 625, Range< 0x04, 0xFFFF > > scan_window_t
 Duration of a scan. More...
 
typedef Duration< uint16_t, 1250, Range< 0x06, 0x0C80 > > conn_interval_t
 Time interval between two connection events. More...
 
typedef Duration< uint16_t, 10000, Range< 0x0A, 0x0C80 > > supervision_timeout_t
 Time after which a connection is loss of devices have not exchanged data. More...
 
typedef Duration< uint16_t, 625, Range< 0, 0xFFFF > > conn_event_length_t
 Duration of a connection event. More...
 
typedef Duration< uint16_t, 10000, Range< 0x0A, 0x4000 > > sync_timeout_t
 Time after which a periodic sync link is considered lost if the receiver hasn't received anything from the advertiser. More...
 
typedef Duration< uint16_t, 1250, Range< 0x06, 0xFFFF > > periodic_interval_t
 Interval between two periodic advertising events. More...
 
typedef Bounded< uint16_t, 0, 0x01F3 > slave_latency_t
 Number of connection events that can be skipped by the slave. More...
 
typedef uint8_t advertising_handle_t
 Handle of an advertising set. More...
 
typedef uint16_t periodic_sync_handle_t
 Handle of a sync representing a periodic advertiser. More...
 
typedef uint8_t advertising_sid_t
 Identify an advertising SID. More...
 
typedef int8_t rssi_t
 Received signal strength. More...
 
typedef int8_t advertising_power_t
 Describe the advertising power. More...
 

Detailed Description

Typedef Documentation

typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF>, Value<uint16_t, 0x0000> > adv_duration_t

Advertising process duration.

The duration is in unit of 10ms and ranges from 0x0001 to 0xFFFF. The special value 0x0000 means the advertising process never ends; it is accessible with adv_duration_t::forever().

Definition at line 51 of file Types.h.

typedef Duration<uint32_t, 625, Range<0x20, 0xFFFFFF> > adv_interval_t

Time interval between two advertisements.

The duration is in unit of 625µs and ranges from 0x20 to 0xFFFFFF .

Note
before Bluetooth 5 range was 0x20 to 0xFFFF.

Definition at line 42 of file Types.h.

typedef uint8_t advertising_handle_t

Handle of an advertising set.

Note
Range of valid handle is comprised between 0x00 and 0xEF.

Definition at line 134 of file Types.h.

typedef int8_t advertising_power_t

Describe the advertising power.

Values between -127 and +126 are considered power values in dBm while the special value 127 can be used as a wildcard to indicate that the host has no preference or if the power information is not available.

Definition at line 377 of file Types.h.

typedef uint8_t advertising_sid_t

Identify an advertising SID.

Range: [0x00, 0x0F]

Definition at line 364 of file Types.h.

typedef Duration<uint16_t, 625, Range<0, 0xFFFF> > conn_event_length_t

Duration of a connection event.

The duration is in unit of 625µs and ranges from 0x0 to 0xFFFF .

Definition at line 105 of file Types.h.

typedef Duration<uint16_t, 1250, Range<0x06, 0x0C80> > conn_interval_t

Time interval between two connection events.

The interval is in unit of 1.250 milliseconds and ranges from 0x06 to 0xC80.

Definition at line 89 of file Types.h.

typedef Duration<uint16_t, 1250, Range<0x06, 0xFFFF> > periodic_interval_t

Interval between two periodic advertising events.

The duration is in unit of 1.250ms and ranges from 0x06 to 0xFFFF.

Definition at line 120 of file Types.h.

typedef uint16_t periodic_sync_handle_t

Handle of a sync representing a periodic advertiser.

Note
Range of valid handle is comprised between 0x0000 and 0xFFFF.

Definition at line 141 of file Types.h.

typedef int8_t rssi_t

Received signal strength.

Range <-127, 20>.

Note
Special value 127 means RSSI is not available.

Definition at line 368 of file Types.h.

typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF>, Value<uint16_t, 0x0000> > scan_duration_t

Scan process duration.

The duration is in unit of 10ms and ranges from 0x0001 to 0xFFFF. The special value 0x0000 means the scan process never ends; it is accessible with scan_duration_t::forever().

Definition at line 60 of file Types.h.

typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_interval_t

Time interval between two scans.

The duration is in unit of 625µs and ranges from 0x04 to 0xFFFF.

Definition at line 75 of file Types.h.

typedef Duration<uint16_t, 1280000, Range<0x00, 0xFFFF> > scan_period_t

Time interval between two scan processes.

The duration is in unit of 1.28s and ranges from 0x0001 to 0xFFFF. The special value 0x0000 is used to indicate that scan_period_t is not used.

Definition at line 68 of file Types.h.

typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_window_t

Duration of a scan.

The duration is in unit of 625µs and ranges from 0x04 to 0xFFFF.

Definition at line 82 of file Types.h.

typedef Bounded<uint16_t, 0, 0x01F3> slave_latency_t

Number of connection events that can be skipped by the slave.

It ranges from 0 to 0x1F3.

Definition at line 127 of file Types.h.

typedef Duration<uint16_t, 10000, Range<0x0A, 0x0C80> > supervision_timeout_t

Time after which a connection is loss of devices have not exchanged data.

The duration is in unit of 10 milliseconds and ranges from 0x0A to 0xC80.

Note
this time should be no larger than (1 + ConnLatency) * ConnIntervalMax * 2

Definition at line 98 of file Types.h.

typedef Duration<uint16_t, 10000, Range<0x0A, 0x4000> > sync_timeout_t

Time after which a periodic sync link is considered lost if the receiver hasn't received anything from the advertiser.

The duration is in unit of 10 milliseconds and ranges from 0x0A to 0x4000.

Definition at line 113 of file Types.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.