bt_gatt_read_params Struct Reference

GATT Read parameters. More...

#include <gatt.h>

Data Fields
bt_gatt_read_func_t	func
	Read attribute callback.
size_t	handle_count
	If equals to 1 single.handle and single.offset are used.
union {
struct {
uint16_t   handle
	Attribute handle. More...
uint16_t   offset
	Attribute data offset. More...
}   single
struct {
uint16_t *   handles
	Attribute handles to read with Read Multiple Characteristic Values. More...
bool   variable
	If true use Read Multiple Variable Length Characteristic Values procedure. More...
}   multiple
struct {
uint16_t   start_handle
	Requested start attribute handle number. More...
uint16_t   end_handle
	Requested end attribute handle number. More...
const struct bt_uuid *   uuid
	2 or 16 octet UUID. More...
}   by_uuid
};
enum bt_att_chan_opt	chan_opt
	Att channel options.

Detailed Description

GATT Read parameters.

Field Documentation

[union]

union { ... } bt_gatt_read_params

[struct]

struct { ... } bt_gatt_read_params::by_uuid

chan_opt

enum bt_att_chan_opt bt_gatt_read_params::chan_opt

Att channel options.

end_handle

uint16_t bt_gatt_read_params::end_handle

Requested end attribute handle number.

The end handle is set to the ending point of the range over which this read should be performed. For example, this could be set to BT_ATT_LAST_ATTRIBUTE_HANDLE to set the ending point of the range at the end of the GATT database, or to the end handle for service after discovery, where the end_handle is available in the bt_gatt_service_val.

func

bt_gatt_read_func_t bt_gatt_read_params::func

Read attribute callback.

handle

uint16_t bt_gatt_read_params::handle

Attribute handle.

handle_count

size_t bt_gatt_read_params::handle_count

If equals to 1 single.handle and single.offset are used.

If greater than 1 multiple.handles are used. If equals to 0 by_uuid is used for Read Using Characteristic UUID.

handles

uint16_t* bt_gatt_read_params::handles

Attribute handles to read with Read Multiple Characteristic Values.

[struct]

struct { ... } bt_gatt_read_params::multiple

offset

uint16_t bt_gatt_read_params::offset

Attribute data offset.

[struct]

struct { ... } bt_gatt_read_params::single

start_handle

uint16_t bt_gatt_read_params::start_handle

Requested start attribute handle number.

The starting handle is set to the starting point of the range over which this read should be performed. For example, this could be set to BT_ATT_FIRST_ATTRIBUTE_HANDLE to set the starting point of the range at the beginning of the GATT database, or to the starting handle of a service after discovery.

This value is automatically incremented by the stack after processing each matching handle-value pair returned by the server.

uuid

const struct bt_uuid* bt_gatt_read_params::uuid

2 or 16 octet UUID.

variable

bool bt_gatt_read_params::variable

If true use Read Multiple Variable Length Characteristic Values procedure.

The values of the set of attributes may be of variable or unknown length. If false use Read Multiple Characteristic Values procedure. The values of the set of attributes must be of a known fixed length, with the exception of the last value that can have a variable length.

---

The documentation for this struct was generated from the following file:

• zephyr/bluetooth/gatt.h