nRF5 SDK for Mesh v4.0.0
Copy URL
mesh
core
api
mesh_config_listener.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
#ifndef MESH_CONFIG_LISTENER_H__
38
#define MESH_CONFIG_LISTENER_H__
39
40
#include "nrf_mesh_section.h"
41
#include "mesh_config_entry.h"
42
64
#define MESH_CONFIG_LISTENER(NAME, ID, CALLBACK) \
65
NRF_MESH_SECTION_ITEM_REGISTER_FLASH(mesh_config_entry_listeners, \
66
const mesh_config_listener_t NAME) = {&(ID), CALLBACK}
67
69
typedef
enum
70
{
71
MESH_CONFIG_CHANGE_REASON_SET
,
72
MESH_CONFIG_CHANGE_REASON_DELETE
,
73
}
mesh_config_change_reason_t
;
74
82
typedef
void (*
mesh_config_listener_on_change_t
)(
mesh_config_change_reason_t
reason,
mesh_config_entry_id_t
id,
const
void
* p_entry);
83
90
typedef
struct
91
{
92
const
mesh_config_entry_id_t
*
p_id
;
93
mesh_config_listener_on_change_t
callback
;
94
}
mesh_config_listener_t
;
95
98
#endif
/* MESH_CONFIG_LISTENER_H__ */
mesh_config_listener_t::callback
mesh_config_listener_on_change_t callback
Callback to call when the entry changes.
Definition:
mesh_config_listener.h:93
mesh_config_listener_on_change_t
void(* mesh_config_listener_on_change_t)(mesh_config_change_reason_t reason, mesh_config_entry_id_t id, const void *p_entry)
Mesh config change-listener function type.
Definition:
mesh_config_listener.h:82
mesh_config_entry_id_t
Mesh config entry identifier.
Definition:
mesh_config_entry.h:173
mesh_config_listener_t
Definition:
mesh_config_listener.h:90
mesh_config_change_reason_t
mesh_config_change_reason_t
Reason for the listener invocation.
Definition:
mesh_config_listener.h:69
mesh_config_listener_t::p_id
const mesh_config_entry_id_t * p_id
ID of the entry to listen for.
Definition:
mesh_config_listener.h:92
MESH_CONFIG_CHANGE_REASON_DELETE
The entry was deleted.
Definition:
mesh_config_listener.h:72
MESH_CONFIG_CHANGE_REASON_SET
The entry was changed by a user.
Definition:
mesh_config_listener.h:71