Nicolas Borla / Mbed OS BBR_1Ebene

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

ble Namespace Reference
Data Structures | Typedefs | Functions

ble Namespace Reference
[Common, Ble]

Entry namespace for all BLE API definitions. More...

Data Structures

struct  ArrayView
 Immutable view to an array. More...
struct  attribute_handle_range_t
 Inclusive range of GATT attributes handles. More...
struct  link_encryption_t
 Type that describes link's encryption state. More...
struct  pairing_failure_t
 Type that describe a pairing failure. More...
struct  io_capability_t
 Type that describe the IO capability of a device; it is used during Pairing Feature exchange. More...
class  PasskeyAscii
 Passkey stored as a string of digits. More...
struct  address_t
 MAC address data type. More...
struct  SafeEnum
 Helper class used to define safe enumerations. More...

Typedefs

typedef uintptr_t connection_handle_t
 Opaque reference to a connection.
typedef uint16_t attribute_handle_t
 Reference to an attribute in a GATT database.
typedef uint32_t passkey_num_t
 Passkey stored as a number.
typedef byte_array_t< 16 > irk_t
 128 bit keys used by paired devices
typedef byte_array_t< 2 > ediv_t
 Used to identify LTK for legacy pairing connections.
typedef byte_array_t< 16 > oob_tk_t
 Out of band data exchanged during pairing.
typedef byte_array_t< 16 > oob_lesc_value_t
 secure connections oob random 128 value
typedef byte_array_t< 16 > oob_confirm_t
 secure connections oob confirmation value
typedef byte_array_t< 16 > encryption_block_t
 data to be encrypted
typedef byte_array_t< 32 > public_key_coord_t
 public key coordinate, two of which define the public key
typedef byte_array_t< 32 > dhkey_t
 Diffie-Hellman key.

Functions

template<typename T , size_t Size>
ArrayView< T > make_ArrayView (T(&elements)[Size])
 Generate an array view from a reference to a C/C++ array.
template<typename T >
ArrayView< T > make_ArrayView (T *array_ptr, size_t array_size)
 Generate an array view from a C/C++ pointer and the size of the array.
template<typename T , size_t Size>
ArrayView< const T > make_const_ArrayView (T(&elements)[Size])
 Generate a const array view from a reference to a C/C++ array.
template<typename T >
ArrayView< const T > make_const_ArrayView (T *array_ptr, size_t array_size)
 Generate a const array view from a C/C++ pointer and the size of the array.
static attribute_handle_range_t attribute_handle_range (attribute_handle_t begin, attribute_handle_t end)
 Construct an attribute_handle_range_t from its first and last attribute handle.

Detailed Description

Entry namespace for all BLE API definitions.

Typedef Documentation

typedef uint16_t attribute_handle_t

Reference to an attribute in a GATT database.

Definition at line 48 of file BLETypes.h.

typedef uintptr_t connection_handle_t

Opaque reference to a connection.

Internally a connection handle is an unsigned integer capable of holding a pointer.

The real type (either a pointer to an object or an integer) is opaque for users and platform dependent.

Definition at line 43 of file BLETypes.h.

typedef byte_array_t<32> dhkey_t

Diffie-Hellman key.

Definition at line 359 of file BLETypes.h.

typedef byte_array_t<2> ediv_t

Used to identify LTK for legacy pairing connections.

Definition at line 344 of file BLETypes.h.

typedef byte_array_t<16> encryption_block_t

data to be encrypted

Definition at line 353 of file BLETypes.h.

typedef byte_array_t<16> irk_t

128 bit keys used by paired devices

Definition at line 339 of file BLETypes.h.

typedef byte_array_t<16> oob_confirm_t

secure connections oob confirmation value

Definition at line 350 of file BLETypes.h.

typedef byte_array_t<16> oob_lesc_value_t

secure connections oob random 128 value

Definition at line 349 of file BLETypes.h.

typedef byte_array_t<16> oob_tk_t

Out of band data exchanged during pairing.

legacy pairing TK

Definition at line 348 of file BLETypes.h.

typedef uint32_t passkey_num_t

Passkey stored as a number.

Definition at line 191 of file BLETypes.h.

typedef byte_array_t<32> public_key_coord_t

public key coordinate, two of which define the public key

Definition at line 356 of file BLETypes.h.

Function Documentation

static attribute_handle_range_t ble::attribute_handle_range ( attribute_handle_t  begin,
attribute_handle_t  end 
) [static]

Construct an attribute_handle_range_t from its first and last attribute handle.

Parameters:
[in]beginHandle at the beginning of the range.
[in]endHandle at the end of the range.
Returns:
An instance of attribute_handle_range_t where attribute_handle_range_t::begin is equal to begin and attribute_handle_range_t::end is equal to end.
Note:
This function is defined instead of a constructor to keep "POD-ness" of attribute_handle_range_t.

Definition at line 111 of file BLETypes.h.

ArrayView<T> ble::make_ArrayView ( T *  array_ptr,
size_t  array_size 
)

Generate an array view from a C/C++ pointer and the size of the array.

Template Parameters:
TType of elements held in array_ptr.
Parameters:
array_ptrThe pointer to the array to viewed.
array_sizeThe number of T elements in the array.
Returns:
The ArrayView to array_ptr with a size of array_size.
Note:
This helper avoids the typing of template parameter when ArrayView is created 'inline'.

Definition at line 222 of file ArrayView.h.

ArrayView<T> ble::make_ArrayView ( T(&)  elements[Size] )

Generate an array view from a reference to a C/C++ array.

Template Parameters:
TType of elements held in elements.
SizeNumber of items held in elements.
Parameters:
elementsThe reference to the array viewed.
Returns:
The ArrayView to elements.
Note:
This helper avoids the typing of template parameter when ArrayView is created 'inline'.

Definition at line 203 of file ArrayView.h.

ArrayView<const T> ble::make_const_ArrayView ( T(&)  elements[Size] )

Generate a const array view from a reference to a C/C++ array.

Template Parameters:
TType of elements held in elements.
SizeNumber of items held in elements.
Parameters:
elementsThe array viewed.
Returns:
The ArrayView to elements.
Note:
This helper avoids the typing of template parameter when ArrayView is created 'inline'.

Definition at line 240 of file ArrayView.h.

ArrayView<const T> ble::make_const_ArrayView ( T *  array_ptr,
size_t  array_size 
)

Generate a const array view from a C/C++ pointer and the size of the array.

Template Parameters:
TType of elements held in array_ptr.
Parameters:
array_ptrThe pointer to the array to viewed.
array_sizeThe number of T elements in the array.
Returns:
The ArrayView to array_ptr with a size of array_size.
Note:
This helper avoids the typing of template parameter when ArrayView is created 'inline'.

Definition at line 259 of file ArrayView.h.

Generated on Tue Jul 12 2022 18:19:07 by  doxygen 1.7.2