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

Enumeration of GAP roles. More...

#include <Types.h>

Inheritance diagram for connection_role_t:
SafeEnum< connection_role_t, uint8_t >

Public Types

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

Public Member Functions

 connection_role_t (type value)
 Construct a new instance of role_t. 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

Enumeration of GAP roles.

Note
The BLE API does not express the broadcaster and scanner roles.
Attention
A device can fulfill different roles concurrently.

Definition at line 697 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

struct scoped enum wrapped by the class

Enumerator
CENTRAL 

Central Role.

The device can scan and initiate connection to peripherals. It acts as the master when a connection is established.

Note
A central is a scanner.
PERIPHERAL 

Peripheral Role.

The device can advertise, and you can connect it by a central. It acts as a slave when connected.

Note
A peripheral is a broadcaster.

Definition at line 699 of file Types.h.

Constructor & Destructor Documentation

connection_role_t ( type  value)

Construct a new instance of role_t.

Parameters
valueThe value of the role_t created.

Definition at line 726 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.