The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_VBLUNO51/TOOLCHAIN_GCC_ARM/gatt_cache_manager.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_VBLUNO51/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/ble/peer_manager/gatt_cache_manager.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 143:86740a56073b | 1 | /* |
AnnaBridge | 143:86740a56073b | 2 | * Copyright (c) 2015 Nordic Semiconductor ASA |
AnnaBridge | 143:86740a56073b | 3 | * All rights reserved. |
AnnaBridge | 143:86740a56073b | 4 | * |
AnnaBridge | 143:86740a56073b | 5 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 143:86740a56073b | 6 | * are permitted provided that the following conditions are met: |
AnnaBridge | 143:86740a56073b | 7 | * |
AnnaBridge | 143:86740a56073b | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 143:86740a56073b | 9 | * of conditions and the following disclaimer. |
AnnaBridge | 143:86740a56073b | 10 | * |
AnnaBridge | 143:86740a56073b | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
AnnaBridge | 143:86740a56073b | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
AnnaBridge | 143:86740a56073b | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
AnnaBridge | 143:86740a56073b | 14 | * the documentation and/or other materials provided with the distribution. |
AnnaBridge | 143:86740a56073b | 15 | * |
AnnaBridge | 143:86740a56073b | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
AnnaBridge | 143:86740a56073b | 17 | * used to endorse or promote products derived from this software without specific prior |
AnnaBridge | 143:86740a56073b | 18 | * written permission. |
AnnaBridge | 143:86740a56073b | 19 | * |
AnnaBridge | 143:86740a56073b | 20 | * 4. This software, with or without modification, must only be used with a |
AnnaBridge | 143:86740a56073b | 21 | * Nordic Semiconductor ASA integrated circuit. |
AnnaBridge | 143:86740a56073b | 22 | * |
AnnaBridge | 143:86740a56073b | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
AnnaBridge | 143:86740a56073b | 24 | * engineered, decompiled, modified and/or disassembled. |
AnnaBridge | 143:86740a56073b | 25 | * |
AnnaBridge | 143:86740a56073b | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 143:86740a56073b | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 143:86740a56073b | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 143:86740a56073b | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 143:86740a56073b | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 143:86740a56073b | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 143:86740a56073b | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 143:86740a56073b | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 143:86740a56073b | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 143:86740a56073b | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 143:86740a56073b | 36 | * |
AnnaBridge | 143:86740a56073b | 37 | */ |
AnnaBridge | 143:86740a56073b | 38 | |
AnnaBridge | 143:86740a56073b | 39 | |
AnnaBridge | 143:86740a56073b | 40 | |
AnnaBridge | 143:86740a56073b | 41 | #ifndef GATT_CACHE_MANAGER_H__ |
AnnaBridge | 143:86740a56073b | 42 | #define GATT_CACHE_MANAGER_H__ |
AnnaBridge | 143:86740a56073b | 43 | |
AnnaBridge | 143:86740a56073b | 44 | #include <stdint.h> |
AnnaBridge | 143:86740a56073b | 45 | #include "sdk_errors.h" |
AnnaBridge | 143:86740a56073b | 46 | #include "nrf_ble.h" |
AnnaBridge | 143:86740a56073b | 47 | #include "nrf_ble_gap.h" |
AnnaBridge | 143:86740a56073b | 48 | #include "peer_manager_types.h" |
AnnaBridge | 143:86740a56073b | 49 | |
AnnaBridge | 143:86740a56073b | 50 | |
AnnaBridge | 143:86740a56073b | 51 | |
AnnaBridge | 143:86740a56073b | 52 | /** |
AnnaBridge | 143:86740a56073b | 53 | * @cond NO_DOXYGEN |
AnnaBridge | 143:86740a56073b | 54 | * @defgroup gatt_cache_manager GATT Cache Manager |
AnnaBridge | 143:86740a56073b | 55 | * @ingroup peer_manager |
AnnaBridge | 143:86740a56073b | 56 | * @{ |
AnnaBridge | 143:86740a56073b | 57 | * @brief An internal module of @ref peer_manager. A module for managing persistent storing of GATT |
AnnaBridge | 143:86740a56073b | 58 | * attributes. |
AnnaBridge | 143:86740a56073b | 59 | */ |
AnnaBridge | 143:86740a56073b | 60 | |
AnnaBridge | 143:86740a56073b | 61 | |
AnnaBridge | 143:86740a56073b | 62 | /**@brief Events that can come from the GATT Cache Manager module. |
AnnaBridge | 143:86740a56073b | 63 | */ |
AnnaBridge | 143:86740a56073b | 64 | typedef enum |
AnnaBridge | 143:86740a56073b | 65 | { |
AnnaBridge | 143:86740a56073b | 66 | GCM_EVT_LOCAL_DB_CACHE_STORED, /**< The persistent cache for the local database has been updated with provided values, for one peer. */ |
AnnaBridge | 143:86740a56073b | 67 | GCM_EVT_LOCAL_DB_CACHE_UPDATED, /**< The persistent cache for the local database has been updated with values from the SoftDevice, for one peer. */ |
AnnaBridge | 143:86740a56073b | 68 | GCM_EVT_LOCAL_DB_CACHE_APPLIED, /**< The SoftDevice has been given local database values from the persistent cache, for one peer. */ |
AnnaBridge | 143:86740a56073b | 69 | GCM_EVT_ERROR_LOCAL_DB_CACHE_APPLY, /**< The stored local database values for a peer were rejected by the SoftDevice, which means the database has changed. */ |
AnnaBridge | 143:86740a56073b | 70 | GCM_EVT_REMOTE_DB_CACHE_UPDATED, /**< The persistent cache for the remote database has been updated with provided values, for one peer. */ |
AnnaBridge | 143:86740a56073b | 71 | GCM_EVT_SERVICE_CHANGED_IND_SENT, /**< A service changed indication has been sent to a peer. */ |
AnnaBridge | 143:86740a56073b | 72 | GCM_EVT_SERVICE_CHANGED_IND_CONFIRMED, /**< A sent service changed indication has been confirmed by a peer. */ |
AnnaBridge | 143:86740a56073b | 73 | GCM_EVT_ERROR_DATA_SIZE, /**< An operation failed because the write buffer of the Peer Database module was not large enough. This is a fatal error. */ |
AnnaBridge | 143:86740a56073b | 74 | GCM_EVT_ERROR_STORAGE_FULL, /**< An operation failed because there was no available storage room in persistent storage. Please free up room, and the operation will automatically continue. */ |
AnnaBridge | 143:86740a56073b | 75 | GCM_EVT_ERROR_UNEXPECTED, /**< An operation failed with an unexpected error. The error is provided. This is possibly a fatal error. */ |
AnnaBridge | 143:86740a56073b | 76 | } gcm_evt_id_t; |
AnnaBridge | 143:86740a56073b | 77 | |
AnnaBridge | 143:86740a56073b | 78 | |
AnnaBridge | 143:86740a56073b | 79 | /**@brief A structure meant to be used for event parameters for multiple event types. |
AnnaBridge | 143:86740a56073b | 80 | */ |
AnnaBridge | 143:86740a56073b | 81 | typedef struct |
AnnaBridge | 143:86740a56073b | 82 | { |
AnnaBridge | 143:86740a56073b | 83 | uint16_t conn_handle; /**< The connection handle. Likely the connection handle an event pertains to. */ |
AnnaBridge | 143:86740a56073b | 84 | } gcm_evt_param_conn_handle_t; |
AnnaBridge | 143:86740a56073b | 85 | |
AnnaBridge | 143:86740a56073b | 86 | |
AnnaBridge | 143:86740a56073b | 87 | /**@brief Structure containing an event from the GCM module. |
AnnaBridge | 143:86740a56073b | 88 | */ |
AnnaBridge | 143:86740a56073b | 89 | typedef struct |
AnnaBridge | 143:86740a56073b | 90 | { |
AnnaBridge | 143:86740a56073b | 91 | gcm_evt_id_t evt_id; /**< The type of event this is. */ |
AnnaBridge | 143:86740a56073b | 92 | pm_peer_id_t peer_id; /**< The peer ID this event pertains to. */ |
AnnaBridge | 143:86740a56073b | 93 | union |
AnnaBridge | 143:86740a56073b | 94 | { |
AnnaBridge | 143:86740a56073b | 95 | gcm_evt_param_conn_handle_t local_db_cache_updated; |
AnnaBridge | 143:86740a56073b | 96 | gcm_evt_param_conn_handle_t local_db_cache_applied; |
AnnaBridge | 143:86740a56073b | 97 | gcm_evt_param_conn_handle_t error_local_db_cache_apply; |
AnnaBridge | 143:86740a56073b | 98 | gcm_evt_param_conn_handle_t service_changed_ind_sent; |
AnnaBridge | 143:86740a56073b | 99 | gcm_evt_param_conn_handle_t service_changed_ind_confirmed; |
AnnaBridge | 143:86740a56073b | 100 | gcm_evt_param_conn_handle_t error_data_size; |
AnnaBridge | 143:86740a56073b | 101 | gcm_evt_param_conn_handle_t error_no_mem; |
AnnaBridge | 143:86740a56073b | 102 | struct |
AnnaBridge | 143:86740a56073b | 103 | { |
AnnaBridge | 143:86740a56073b | 104 | uint16_t conn_handle; /**< The handle of the connection the event pertains to. */ |
AnnaBridge | 143:86740a56073b | 105 | ret_code_t error; /**< The unexpected error that occurred. */ |
AnnaBridge | 143:86740a56073b | 106 | } error_unexpected; |
AnnaBridge | 143:86740a56073b | 107 | } params; /**< Event specific parameters. Chosen based on evt_id. */ |
AnnaBridge | 143:86740a56073b | 108 | } gcm_evt_t; |
AnnaBridge | 143:86740a56073b | 109 | |
AnnaBridge | 143:86740a56073b | 110 | /**@brief Event handler for events from the GATT Cache Manager module. |
AnnaBridge | 143:86740a56073b | 111 | * |
AnnaBridge | 143:86740a56073b | 112 | * @param[in] event The event that has happened. |
AnnaBridge | 143:86740a56073b | 113 | * @param[in] peer The id of the peer the event pertains to. |
AnnaBridge | 143:86740a56073b | 114 | * @param[in] flags The data the event pertains to. |
AnnaBridge | 143:86740a56073b | 115 | */ |
AnnaBridge | 143:86740a56073b | 116 | typedef void (*gcm_evt_handler_t)(gcm_evt_t const * p_event); |
AnnaBridge | 143:86740a56073b | 117 | |
AnnaBridge | 143:86740a56073b | 118 | |
AnnaBridge | 143:86740a56073b | 119 | /**@brief Function for initializing the GATT Cache Manager module. |
AnnaBridge | 143:86740a56073b | 120 | * |
AnnaBridge | 143:86740a56073b | 121 | * @param[in] evt_handler Callback for events from the GATT Cache Manager module. |
AnnaBridge | 143:86740a56073b | 122 | * |
AnnaBridge | 143:86740a56073b | 123 | * @retval NRF_SUCCESS Initialization was successful. |
AnnaBridge | 143:86740a56073b | 124 | * @retval NRF_ERROR_NULL evt_handler was NULL. |
AnnaBridge | 143:86740a56073b | 125 | */ |
AnnaBridge | 143:86740a56073b | 126 | ret_code_t gcm_init(gcm_evt_handler_t evt_handler); |
AnnaBridge | 143:86740a56073b | 127 | |
AnnaBridge | 143:86740a56073b | 128 | |
AnnaBridge | 143:86740a56073b | 129 | /**@brief Function for dispatching SoftDevice events to the GATT Cache Manager module. |
AnnaBridge | 143:86740a56073b | 130 | * |
AnnaBridge | 143:86740a56073b | 131 | * @param[in] p_ble_evt The SoftDevice event. |
AnnaBridge | 143:86740a56073b | 132 | */ |
AnnaBridge | 143:86740a56073b | 133 | void gcm_ble_evt_handler(ble_evt_t * p_ble_evt); |
AnnaBridge | 143:86740a56073b | 134 | |
AnnaBridge | 143:86740a56073b | 135 | |
AnnaBridge | 143:86740a56073b | 136 | |
AnnaBridge | 143:86740a56073b | 137 | /**@brief Function for storing a discovered remote database persistently. |
AnnaBridge | 143:86740a56073b | 138 | * |
AnnaBridge | 143:86740a56073b | 139 | * @param[in] peer_id Peer to store the database for. |
AnnaBridge | 143:86740a56073b | 140 | * @param[in] p_remote_db Database values to store as an array. Can be NULL if n_services is 0. |
AnnaBridge | 143:86740a56073b | 141 | * @param[in] n_services Number of services in p_remote_db array. If 0, values are cleared. |
AnnaBridge | 143:86740a56073b | 142 | * |
AnnaBridge | 143:86740a56073b | 143 | * @retval NRF_SUCCESS Store procedure successfully started. |
AnnaBridge | 143:86740a56073b | 144 | * @retval NRF_ERROR_NOT_FOUND The peer id is invalid or unallocated. |
AnnaBridge | 143:86740a56073b | 145 | * @retval NRF_ERROR_INVALID_STATE Module is not initialized. |
AnnaBridge | 143:86740a56073b | 146 | */ |
AnnaBridge | 143:86740a56073b | 147 | ret_code_t gcm_remote_db_store(pm_peer_id_t peer_id, |
AnnaBridge | 143:86740a56073b | 148 | ble_gatt_db_srv_t * p_remote_db, |
AnnaBridge | 143:86740a56073b | 149 | uint32_t n_services); |
AnnaBridge | 143:86740a56073b | 150 | |
AnnaBridge | 143:86740a56073b | 151 | |
AnnaBridge | 143:86740a56073b | 152 | /**@brief Function for retrieving a persistently stored remote database. |
AnnaBridge | 143:86740a56073b | 153 | * |
AnnaBridge | 143:86740a56073b | 154 | * @param[in] peer_id Peer to retrieve data for. |
AnnaBridge | 143:86740a56073b | 155 | * @param[out] p_remote_db If p_n_services was large enough: Copied database values. |
AnnaBridge | 143:86740a56073b | 156 | * @param[inout] p_n_services In: Size of provided p_remote_db array. Out: Size of data in flash. |
AnnaBridge | 143:86740a56073b | 157 | * |
AnnaBridge | 143:86740a56073b | 158 | * @note p_n_services is always updated with the size of the data to be retrieved. The data is only |
AnnaBridge | 143:86740a56073b | 159 | * copied if p_remote_db is large enough (p_n_services is large enough initially). |
AnnaBridge | 143:86740a56073b | 160 | * |
AnnaBridge | 143:86740a56073b | 161 | * @retval NRF_SUCCESS Data retrieved successfully. |
AnnaBridge | 143:86740a56073b | 162 | * @retval NRF_ERROR_NOT_FOUND The peer ID is invalid or unallocated. |
AnnaBridge | 143:86740a56073b | 163 | * @retval NRF_ERROR_NULL p_remote_db is NULL. |
AnnaBridge | 143:86740a56073b | 164 | * @retval NRF_ERROR_INVALID_STATE Module is not initialized. |
AnnaBridge | 143:86740a56073b | 165 | */ |
AnnaBridge | 143:86740a56073b | 166 | ret_code_t gcm_remote_db_retrieve(pm_peer_id_t peer_id, |
AnnaBridge | 143:86740a56073b | 167 | ble_gatt_db_srv_t * p_remote_db, |
AnnaBridge | 143:86740a56073b | 168 | uint32_t * p_n_services); |
AnnaBridge | 143:86740a56073b | 169 | |
AnnaBridge | 143:86740a56073b | 170 | |
AnnaBridge | 143:86740a56073b | 171 | /**@brief Function for triggering local GATT database data to be stored persistently. Values are |
AnnaBridge | 143:86740a56073b | 172 | * retrieved from SoftDevice and written to persistent storage. |
AnnaBridge | 143:86740a56073b | 173 | * |
AnnaBridge | 143:86740a56073b | 174 | * @note This function is only needed when you want to override the regular functionality of the |
AnnaBridge | 143:86740a56073b | 175 | * module, e.g. to immediately store to flash instead of waiting for the native logic to |
AnnaBridge | 143:86740a56073b | 176 | * perform the update. |
AnnaBridge | 143:86740a56073b | 177 | * |
AnnaBridge | 143:86740a56073b | 178 | * @param[in] conn_handle Connection handle to perform update on. |
AnnaBridge | 143:86740a56073b | 179 | * |
AnnaBridge | 143:86740a56073b | 180 | * @retval NRF_SUCCESS Store operation started. |
AnnaBridge | 143:86740a56073b | 181 | * @retval BLE_ERROR_INVALID_CONN_HANDLE conn_handle does not refer to an active, bonded connection. |
AnnaBridge | 143:86740a56073b | 182 | * @retval NRF_ERROR_DATA_SIZE Write buffer not large enough. Call will never work with |
AnnaBridge | 143:86740a56073b | 183 | * this GATT database. |
AnnaBridge | 143:86740a56073b | 184 | * @retval NRF_ERROR_NO_MEM No room in persistent_storage. Free up space; the |
AnnaBridge | 143:86740a56073b | 185 | * operation will be automatically reattempted after the |
AnnaBridge | 143:86740a56073b | 186 | * next compression procedure |
AnnaBridge | 143:86740a56073b | 187 | * @retval NRF_ERROR_INVALID_STATE Module is not initialized. |
AnnaBridge | 143:86740a56073b | 188 | */ |
AnnaBridge | 143:86740a56073b | 189 | ret_code_t gcm_local_db_cache_update(uint16_t conn_handle); |
AnnaBridge | 143:86740a56073b | 190 | |
AnnaBridge | 143:86740a56073b | 191 | |
AnnaBridge | 143:86740a56073b | 192 | /**@brief Function for setting new values in the local database cache. |
AnnaBridge | 143:86740a56073b | 193 | * |
AnnaBridge | 143:86740a56073b | 194 | * @note If the peer is connected, the values will also be applied immediately to the connection. |
AnnaBridge | 143:86740a56073b | 195 | * @note This function is only needed when you want to override the regular functionality of the |
AnnaBridge | 143:86740a56073b | 196 | * module. |
AnnaBridge | 143:86740a56073b | 197 | * @note The data in the pointer must be available until the GCM_EVT_LOCAL_DB_CACHE_SET event is |
AnnaBridge | 143:86740a56073b | 198 | * received. |
AnnaBridge | 143:86740a56073b | 199 | * |
AnnaBridge | 143:86740a56073b | 200 | * @param[in] peer_id Peer to set values for. |
AnnaBridge | 143:86740a56073b | 201 | * @param[in] p_local_db Database values to apply. If NULL, the values will instead be cleared. |
AnnaBridge | 143:86740a56073b | 202 | * |
AnnaBridge | 143:86740a56073b | 203 | * @retval NRF_SUCCESS Operation started, and values were applied (if connected). |
AnnaBridge | 143:86740a56073b | 204 | * @retval NRF_ERROR_NOT_FOUND The peer ID was invalid or unallocated. |
AnnaBridge | 143:86740a56073b | 205 | * @retval NRF_ERROR_INVALID_STATE Module is not initialized. |
AnnaBridge | 143:86740a56073b | 206 | */ |
AnnaBridge | 143:86740a56073b | 207 | ret_code_t gcm_local_db_cache_set(pm_peer_id_t peer_id, pm_peer_data_local_gatt_db_t * p_local_db); |
AnnaBridge | 143:86740a56073b | 208 | |
AnnaBridge | 143:86740a56073b | 209 | |
AnnaBridge | 143:86740a56073b | 210 | /**@brief Function for retrieving values in the local database cache. |
AnnaBridge | 143:86740a56073b | 211 | * |
AnnaBridge | 143:86740a56073b | 212 | * @note This function is not needed for regular operation of the module. |
AnnaBridge | 143:86740a56073b | 213 | * |
AnnaBridge | 143:86740a56073b | 214 | * @param[in] peer_id Peer to get values for. |
AnnaBridge | 143:86740a56073b | 215 | * @param[out] p_local_db Database values. |
AnnaBridge | 143:86740a56073b | 216 | * |
AnnaBridge | 143:86740a56073b | 217 | * @retval NRF_SUCCESS Values retrieved successfully. |
AnnaBridge | 143:86740a56073b | 218 | * @retval NRF_ERROR_NOT_FOUND The peer ID was invalid or unallocated. |
AnnaBridge | 143:86740a56073b | 219 | * @retval NRF_ERROR_NULL p_local_db was NULL. |
AnnaBridge | 143:86740a56073b | 220 | * @retval NRF_ERROR_INVALID_STATE Module is not initialized. |
AnnaBridge | 143:86740a56073b | 221 | */ |
AnnaBridge | 143:86740a56073b | 222 | ret_code_t gcm_local_db_cache_get(pm_peer_id_t peer_id, pm_peer_data_local_gatt_db_t * p_local_db); |
AnnaBridge | 143:86740a56073b | 223 | |
AnnaBridge | 143:86740a56073b | 224 | |
AnnaBridge | 143:86740a56073b | 225 | /**@brief Function for manually informing that the local database has changed. |
AnnaBridge | 143:86740a56073b | 226 | * |
AnnaBridge | 143:86740a56073b | 227 | * @details This causes a service changed notification to be sent to all bonded peers that |
AnnaBridge | 143:86740a56073b | 228 | * subscribe to it. |
AnnaBridge | 143:86740a56073b | 229 | */ |
AnnaBridge | 143:86740a56073b | 230 | void gcm_local_database_has_changed(void); |
AnnaBridge | 143:86740a56073b | 231 | |
AnnaBridge | 143:86740a56073b | 232 | /** @} |
AnnaBridge | 143:86740a56073b | 233 | * @endcond |
AnnaBridge | 143:86740a56073b | 234 | */ |
AnnaBridge | 143:86740a56073b | 235 | |
AnnaBridge | 143:86740a56073b | 236 | #endif /* GATT_CACHE_MANAGER_H__ */ |