Lines Matching +full:read +full:- +full:only
6 * Copyright (c) 2015-2016 Intel Corporation
8 * SPDX-License-Identifier: Apache-2.0
38 /** No operations supported, e.g. for notify-only */
41 /** Attribute read permission. */
47 /** @brief Attribute read permission with encryption.
49 * If set, requires encryption for read access.
59 /** @brief Attribute read permission with authentication.
61 * If set, requires encryption using authenticated link-key for read
68 * If set, requires encryption using authenticated link-key for write
80 /** @brief Attribute read permission with LE Secure Connection encryption.
82 * If set, requires that LE Secure Connections is used for read access.
94 * @brief Construct error return value for attribute read and write callbacks.
100 #define BT_GATT_ERR(_att_err) (-(_att_err))
106 * If set, write callback should only check if the device is
131 * @brief Attribute read callback
133 * The callback can also be used locally to read the contents of the
136 * @param conn The connection that is requesting to read
137 * @param attr The attribute that's being read
138 * @param buf Buffer to place the read result in
139 * @param len Length of data to read
142 * @return Number of bytes read, or in case of an error
172 bt_gatt_attr_read_func_t read; member
248 * @brief Characteristic read property.
403 * @return -EAGAIN if `bt_init()` has been called but `settings_load()` hasn't yet.
526 /** @brief Generic Read Attribute value helper.
528 * Read attribute value from local database storing the result into buffer.
531 * @param attr Attribute to read.
538 * @return number of bytes read in case of success or negative values in
545 /** @brief Read Service Attribute helper.
547 * Read service attribute value from local database storing the result into
549 * @note Only use this with attributes which user_data is a bt_uuid.
552 * @param attr Attribute to read.
553 * @param buf Buffer to store the value read.
557 * @return number of bytes read in case of success or negative values in
635 * @note A secondary service is only intended to be included from a primary
644 /** @brief Read Include Attribute helper.
646 * Read include service attribute value from local database storing the result
648 * @note Only use this with attributes which user_data is a bt_gatt_include.
651 * @param attr Attribute to read.
652 * @param buf Buffer to store the value read.
656 * @return number of bytes read in case of success or negative values in
674 /** @brief Read Characteristic Attribute helper.
676 * Read characteristic attribute value from local database storing the result
678 * @note Only use this with attributes which user_data is a bt_gatt_chrc.
681 * @param attr Attribute to read.
682 * @param buf Buffer to store the value read.
686 * @return number of bytes read in case of success or negative values in
711 * @param _read Characteristic Attribute read callback
785 /** @brief Read Client Characteristic Configuration Attribute helper.
787 * Read CCC attribute value from local database storing the result into buffer
790 * @note Only use this with attributes which user_data is a _bt_gatt_ccc.
793 * @param attr Attribute to read.
794 * @param buf Buffer to store the value read.
798 * @return number of bytes read in case of success or negative values in
809 * @note Only use this with attributes which user_data is a _bt_gatt_ccc.
812 * @param attr Attribute to read.
813 * @param buf Buffer to store the value read.
870 /** @brief Read Characteristic Extended Properties Attribute helper
872 * Read CEP attribute value from local database storing the result into buffer
875 * @note Only use this with attributes which user_data is a bt_gatt_cep.
878 * @param attr Attribute to read
879 * @param buf Buffer to store the value read
883 * @return number of bytes read in case of success or negative values in
901 /** @brief Read Characteristic User Description Descriptor Attribute helper
903 * Read CUD attribute value from local database storing the result into buffer
906 * @note Only use this with attributes which user_data is a NULL-terminated C
910 * @param attr Attribute to read
911 * @param buf Buffer to store the value read
915 * @return number of bytes read in case of success or negative values in
927 * @param _value User description NULL-terminated C string.
935 /** @brief Read Characteristic Presentation format Descriptor Attribute helper
937 * Read CPF attribute value from local database storing the result into buffer
940 * @note Only use this with attributes which user_data is a bt_gatt_pf.
943 * @param attr Attribute to read
944 * @param buf Buffer to store the value read
948 * @return number of bytes read in case of success or negative values in
974 * @param _read Descriptor attribute read callback
991 * @param _read Attribute read callback (@ref bt_gatt_attr_read_func_t).
998 .read = _read, \
1078 * Only use this API to force the use of the ATT_MULTIPLE_HANDLE_VALUE_NTF PDU.
1083 * This API has an additional limitation: it only accepts valid attribute
1098 * @retval -EINVAL
1099 * - One of the attribute handles is invalid.
1100 * - Only one parameter was passed. This API expects 2 or more.
1101 * - Not all `func` were equal or not all `user_data` were equal.
1102 * - One of the characteristics is not notifiable.
1103 * - An UUID was passed in one of the parameters.
1104 * @retval -ERANGE
1105 * - The notifications cannot all fit in a single ATT_MULTIPLE_HANDLE_VALUE_NTF.
1106 * - They exceed the MTU of all open ATT bearers.
1107 * @retval -EPERM
1110 * @retval -EOPNOTSUPP
1121 * notification only the given connection.
1158 * notification only on the given connection.
1243 * direct indication only the given connection.
1320 * @note Shall only be used once per connection.
1322 * The Response comes in callback @p params->func. The callback is run from
1332 * @retval 0 Successfully queued request. Will call @p params->func on
1335 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1340 * @retval -EALREADY The MTU exchange procedure has been already performed.
1360 * Only the following fields of the attribute contains valid information:
1361 * - uuid UUID representing the type of attribute.
1362 * - handle Handle in the remote database.
1363 * - user_data The value of the attribute, if the discovery type maps to an
1367 * The effective type of @c attr->user_data is determined by @c params. Note
1368 * that the fields @c params->type and @c params->uuid are left unchanged by
1371 * @c params->type | @c params->uuid | Type of @c attr->user_data
1372 * -------------------------------------|-------------------------|---------------------------
1384 * Also consider if using read-by-type instead of discovery is more convenient.
1431 * - Characteristic Extended Properties
1432 * - Client Characteristic Configuration
1433 * - Server Characteristic Configuration
1434 * - Characteristic Presentation Format
1462 /** Only for stack-internal use, used for automatic discovery. */
1488 * The Response comes in callback @p params->func. The callback is run from
1498 * @retval 0 Successfully queued request. Will call @p params->func on
1501 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1512 * @brief Read callback function
1514 * When reading using by_uuid, `params->start_handle` is the attribute handle
1519 * @param params Read parameters used.
1520 * @param data Attribute value data. NULL means read has completed.
1530 /** @brief GATT Read parameters */
1532 /** Read attribute callback. */
1536 * If equals to 0 by_uuid is used for Read Using Characteristic UUID.
1547 /** Attribute handles to read with Read Multiple
1551 /** If true use Read Multiple Variable Length
1555 * If false use Read Multiple Characteristic Values
1577 /** @brief Read Attribute Value by handle
1579 * This procedure read the attribute value and return it to the callback.
1585 * If an instance does contain a long value which cannot be read entirely the
1586 * caller will need to read the remaining data separately using the handle and
1589 * The Response comes in callback @p params->func. The callback is run from
1597 * @param params Read parameters.
1599 * @retval 0 Successfully queued request. Will call @p params->func on
1602 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1640 * The Response comes in callback @p params->func. The callback is run from
1646 * this function will instead instead return `-ENOMEM` if it would block to
1652 * @retval 0 Successfully queued request. Will call @p params->func on
1655 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1692 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1718 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1736 * In the case of an empty notification, the @p data pointer will be non-NULL
1795 * @note Internal use only.
1807 * @note Internal use only.
1862 * The Response comes in callback @p params->subscribe. The callback is run from
1864 * The Notification callback @p params->notify is also called from the BT RX
1877 * @retval 0 Successfully queued request. Will call @p params->write on
1880 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1914 * The Response comes in callback @p params->func. The callback is run from
1923 * @retval 0 Successfully queued request. Will call @p params->write on
1926 * @retval -ENOMEM ATT request queue is full and blocking would cause deadlock.
1941 * - #bt_gatt_exchange_mtu
1942 * - #bt_gatt_discover
1943 * - #bt_gatt_read
1944 * - #bt_gatt_write
1945 * - #bt_gatt_subscribe
1946 * - #bt_gatt_unsubscribe