nRF5 SDK for Mesh v3.2.0
config_server_events.h
1 /* Copyright (c) 2010 - 2019, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef CONFIG_SERVER_EVENTS_H__
39 #define CONFIG_SERVER_EVENTS_H__
40 
41 #include <stdint.h>
42 #include "device_state_manager.h"
43 #include "access.h"
44 #include "heartbeat.h"
45 
52 typedef enum
53 {
113 
115 typedef struct
116 {
120 
122 typedef struct
123 {
127 
129 typedef struct
130 {
134 
136 typedef struct
137 {
141 
143 typedef struct
144 {
149 
151 typedef struct
152 {
154  uint8_t default_ttl;
156 
158 typedef struct
159 {
163 
165 typedef struct
166 {
172 
174 typedef struct
175 {
181 
183 typedef struct
184 {
188 
190 typedef struct
191 {
197 
199 typedef struct
200 {
204  uint8_t interval_steps;
206 
208 typedef struct
209 {
211  bool enabled;
215  uint8_t interval_steps;
217 
219 typedef struct
220 {
221  const heartbeat_publication_state_t * p_publication_state;
223 
225 typedef struct
226 {
227  const heartbeat_subscription_state_t * p_subscription_state;
229 
231 typedef struct
232 {
238 
240 typedef struct
241 {
242  /* Access model handle. */
243  access_model_handle_t model_handle;
247 
249 typedef struct
250 {
254 
256 typedef struct
257 {
261 
263 typedef struct
264 {
268 
270 typedef struct
271 {
275  union
276  {
278  config_server_evt_appkey_update_t appkey_update;
279  config_server_evt_model_publication_set_t model_publication_set;
280  config_server_evt_appkey_delete_t appkey_delete;
282  config_server_evt_default_ttl_set_t default_ttl_set;
283  config_server_evt_key_refresh_phase_set_t key_refresh_phase_set;
284  config_server_evt_model_subscription_add_t model_subscription_add;
285  config_server_evt_model_subscription_delete_t model_subscription_delete;
286  config_server_evt_model_subscription_delete_all_t model_subscription_delete_all;
287  config_server_evt_model_subscription_overwrite_t model_subscription_overwrite;
288  config_server_evt_network_transmit_set_t network_transmit_set;
290  config_server_evt_heartbeat_publication_set_t heartbeat_publication_set;
291  config_server_evt_heartbeat_subscription_set_t heartbeat_subscription_set;
292  config_server_evt_model_app_bind_t model_app_bind;
293  config_server_evt_model_app_unbind_t model_app_unbind;
295  config_server_evt_netkey_delete_t netkey_delete;
296  config_server_evt_netkey_update_t netkey_update;
297  } params;
299 
304 typedef void (*config_server_evt_cb_t)(const config_server_evt_t * p_evt);
305 
308 #endif /* CONFIG_SERVER_EVENTS_H__ */
Heartbeat publication parameters was set.
The publication paremeters for a given model was set.
uint8_t default_ttl
Default TTL value used for publishing messages.
dsm_handle_t address_handle
DSM address handle.
Config server event Subscription Add parameter structure.
uint8_t interval_steps
Number of interval steps between each re-transmission (10 ms/step).
dsm_handle_t appkey_handle
Application key handle.
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
dsm_handle_t netkey_handle
New network key&#39;s handle.
uint8_t retransmit_count
Number of re-transmissions per relayed message.
All subscriptions was deleted for the given model.
dsm_handle_t netkey_handle
Updated network key&#39;s handle.
dsm_handle_t netkey_handle
Deleted network key&#39;s handle.
A network key was deleted.
All subscriptions was overwritten by a new subscription to a virtual address for the given model...
access_model_handle_t model_handle
Access model handle.
Config server Model Application Unbind event parameter structure.
Config server Network Transmit Set event parameter structure.
config_server_evt_type_t type
Type of event.
Config server Relay Set event parameter structure.
Config server Beacon State event parameter structure.
A subscription was added to the given model.
Configuration server event structure.
The given model was unbound from an application key.
A new network key was added.
access_model_handle_t model_handle
Access model handle.
A subscription to a virtual address was removed from the given model.
dsm_handle_t appkey_handle
Application key handle.
Config server Appkey Update event parameter structure.
uint16_t dsm_handle_t
DSM handle type, used for the handles returned for the each set of data added.
Config server Network Key Update event parameter structure.
dsm_handle_t address_handle
DSM address handle.
Publication to a virtual address for a given model was set.
Config server Heartbeat Subscription Set event parameter structure.
The given application key was deleted.
GATT proxy parameters was set (not supported).
The node was reset, i.e., all mesh state cleared.
access_model_handle_t model_handle
Access model handle.
All subscriptions was overwritten by a new subscription for the given model.
The Node Identity was set (not supported).
bool beacon_state
Current state of the secure network broadcast beacon.
Core relay parameters was set.
Config server Appkey Delete event parameter structure.
A subscription to a virtual address was added to the given model.
access_model_handle_t model_handle
Access model handle.
dsm_handle_t appkey_handle
Application key handle.
Config server Network Key Add event parameter structure.
access_model_handle_t model_handle
Access model handle.
void(* config_server_evt_cb_t)(const config_server_evt_t *p_evt)
Config server event callback type.
uint8_t interval_steps
Number of interval steps between each re-transmission (10 ms/step).
A network key was updated.
dsm_handle_t appkey_handle
Application key handle.
Heartbeat subscription parameters was set.
nrf_mesh_key_refresh_phase_t
Key refresh phase.
Definition: nrf_mesh.h:225
Config server Subscription Delete event parameter structure.
dsm_handle_t appkey_handle
Application key handle.
Config server Subscription Overwrite event parameter structure.
Config server Subscription Delete All event parameter structure.
Config server Key Refresh Phase Set event parameter structure.
uint8_t retransmit_count
Number of retransmissions for each network PDU.
Core network transmission parameters was set.
The given model was bound to a new application key.
access_model_handle_t model_handle
Access model handle.
A new default TTL value was set.
Config server Model Publication Set event parameter structure.
Config server Appkey Add event parameter structure.
Secure network beacon parameters was set.
Friendship parameters was set (not supported).
Low power node poll timeout was set (not supported).
Config server Default TTL Set event parameter structure.
bool enabled
Relay enabled if true, otherwise disabled.
Config server Model Application Bind event parameter structure.
config_server_evt_type_t
Config server Network Key delete event parameter structure.
Config server Heartbeat Publication Set event parameter structure.
A subscription was deleted from the given model.
A new application key was added.
nrf_mesh_key_refresh_phase_t kr_phase
Current key refresh phase.
An existing application key was updated.

Documentation feedback | Developer Zone | Subscribe | Updated