ble/gattdb/client.h header reference
[Bluetooth Low Energy library module]
The source code of this header can be browsed online.
Description [link]
Description [link]
A GATT DB client is an access to a GATT database. It can be concurrent to other clients for a given database.
Client is the consumer-side of a GATT database. For a typical BLE Peripheral, it is the connection from a remote Central.
Client has a lookup role, where it can query the database. It also has a publish/subscribe role where it can monitor a particular attribute value.
Members [link]
Types [link]
- struct ble_gattdb_client_handler_s
- struct ble_gattdb_client_s
- typedef [...] * ble_gattdb_client_sl_item_t
- struct ble_gattdb_client_subs_s
Functions [link]
- enum ble_att_error_e ble_gattdb_char_read(struct ble_gattdb_client_s *client, struct ble_gattdb_registry_s *reg, uint8_t charid, size_t offset, void *data, size_t *size)
- enum ble_att_error_e ble_gattdb_char_write(struct ble_gattdb_client_s *client, struct ble_gattdb_registry_s *reg, uint8_t charid, const void *data, size_t size)
- error_t ble_gattdb_client_att_stream_get(struct ble_gattdb_client_s *client, uint16_t value_handle, struct buffer_s *buffer)
- void ble_gattdb_client_close(struct ble_gattdb_client_s *client)
- enum ble_att_error_e ble_gattdb_client_next(struct ble_gattdb_client_s *client)
- void ble_gattdb_client_open(struct ble_gattdb_client_s *client, const struct ble_gattdb_client_handler_s *handler, struct ble_gattdb_s *db)
- enum ble_att_error_e ble_gattdb_client_read(struct ble_gattdb_client_s *client, size_t offset, void *data, size_t *size)
- enum ble_att_error_e ble_gattdb_client_seek(struct ble_gattdb_client_s *client, uint16_t handle)
- struct ble_gattdb_client_subs_s * ble_gattdb_client_subs_s_from_listener(void *x)
- void ble_gattdb_client_subscription_get(struct ble_gattdb_client_s *client, struct ble_subscription_s *subscriptions, size_t count)
- void ble_gattdb_client_subscription_set(struct ble_gattdb_client_s *client, const struct ble_subscription_s *subscriptions, size_t count)
- uint16_t ble_gattdb_client_tell(struct ble_gattdb_client_s *client)
- enum ble_att_error_e ble_gattdb_client_type_get(struct ble_gattdb_client_s *client, const struct ble_uuid_s **type)
- enum ble_att_error_e ble_gattdb_client_write(struct ble_gattdb_client_s *client, const void *data, size_t size)
Members detail [link]
#define BLE_GATTDB_CLIENT_H [link]
This macro is declared in ble/gattdb/client.h source file, line 21.
#define GCT_CONTAINER_ALGO_ble_gattdb_client_sl [link]
This macro is declared in ble/gattdb/client.h source file, line 58.
enum ble_att_error_e ble_gattdb_char_read(struct ble_gattdb_client_s *client, struct ble_gattdb_registry_s *reg, uint8_t charid, size_t offset, void *data, size_t *size) [link]
This function is declared in ble/gattdb/client.h source file, line 160.
enum ble_att_error_e ble_gattdb_char_write(struct ble_gattdb_client_s *client, struct ble_gattdb_registry_s *reg, uint8_t charid, const void *data, size_t size) [link]
This function is declared in ble/gattdb/client.h source file, line 148.
error_t ble_gattdb_client_att_stream_get(struct ble_gattdb_client_s *client, uint16_t value_handle, struct buffer_s *buffer) [link]
This function is declared in ble/gattdb/client.h source file, line 127.
Preprocessor condition: defined( CONFIG_BLE_GATTDB_STREAM )
void ble_gattdb_client_close(struct ble_gattdb_client_s *client) [link]
This function is declared in ble/gattdb/client.h source file, line 101.
struct ble_gattdb_client_handler_s [link]
This struct is declared in ble/gattdb/client.h source file, line 74.
| Field | Description |
|---|---|
| error_t (*att_value_changed)(struct ble_gattdb_client_s *client, uint16_t value_handle, uint16_t mode, const void *datasize_t size) ; | |
| void (*att_stream_resume)(struct ble_gattdb_client_s *client, uint16_t value_handle) ; | |
| void (*att_subscription_changed)(struct ble_gattdb_client_s *client) ; |
enum ble_att_error_e ble_gattdb_client_next(struct ble_gattdb_client_s *client) [link]
This function is declared in ble/gattdb/client.h source file, line 112.
void ble_gattdb_client_open(struct ble_gattdb_client_s *client, const struct ble_gattdb_client_handler_s *handler, struct ble_gattdb_s *db) [link]
This function is declared in ble/gattdb/client.h source file, line 99.
enum ble_att_error_e ble_gattdb_client_read(struct ble_gattdb_client_s *client, size_t offset, void *data, size_t *size) [link]
This function is declared in ble/gattdb/client.h source file, line 119.
struct ble_gattdb_client_s [link]
This struct is declared in ble/gattdb/client.h source file, line 85.
| Field | Description |
|---|---|
| struct ble_gattdb_s * db; | |
| const struct ble_gattdb_client_handler_s * handler; | |
| ble_gattdb_client_sl_root_t subs_list; | |
| struct <anonymous> { | |
| struct ble_gattdb_registry_s * registry; | |
| uint16_t handle; | |
| } cursor; | |
| bool_t encrypted:1; | |
| bool_t authenticated:1; |
enum ble_att_error_e ble_gattdb_client_seek(struct ble_gattdb_client_s *client, uint16_t handle) [link]
This function is declared in ble/gattdb/client.h source file, line 110.
typedef void * ble_gattdb_client_sl_entry_t [link]
This typedef is declared in ble/gattdb/client.h source file, line 71.
typedef struct ble_gattdb_client_subs_s * ble_gattdb_client_sl_item_t [link]
This typedef is declared in ble/gattdb/client.h source file, line 71.
typedef void * ble_gattdb_client_sl_root_t [link]
This typedef is declared in ble/gattdb/client.h source file, line 71.
struct ble_gattdb_client_subs_s [link]
This struct is declared in ble/gattdb/client.h source file, line 62.
| Field | Description |
|---|---|
| struct ble_gattdb_listener_s listener; | |
| uint16_t mode; | |
| struct ble_gattdb_client_s * client; |
See also ble_gattdb_client_sl_item_t.
struct ble_gattdb_client_subs_s * ble_gattdb_client_subs_s_from_listener(void *x) [link]
This function is declared in ble/gattdb/client.h source file, line 69.
void ble_gattdb_client_subscription_get(struct ble_gattdb_client_s *client, struct ble_subscription_s *subscriptions, size_t count) [link]
This function is declared in ble/gattdb/client.h source file, line 132.
void ble_gattdb_client_subscription_set(struct ble_gattdb_client_s *client, const struct ble_subscription_s *subscriptions, size_t count) [link]
This function is declared in ble/gattdb/client.h source file, line 136.
uint16_t ble_gattdb_client_tell(struct ble_gattdb_client_s *client) [link]
This function is declared in ble/gattdb/client.h source file, line 105.
enum ble_att_error_e ble_gattdb_client_type_get(struct ble_gattdb_client_s *client, const struct ble_uuid_s **type) [link]
This function is declared in ble/gattdb/client.h source file, line 115.
enum ble_att_error_e ble_gattdb_client_write(struct ble_gattdb_client_s *client, const void *data, size_t size) [link]
This function is declared in ble/gattdb/client.h source file, line 122.