thread_net_config_api.h

00001 /*
00002  * Copyright (c) 2016-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: BSD-3-Clause
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holder nor the
00014  *    names of its contributors may be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 /**
00031  * \file thread_net_config_api.h
00032  * \brief Public API to handle the Thread network services and configuration.
00033  */
00034 
00035 #ifndef _THREAD_NET_CONFIG_API_H_
00036 #define _THREAD_NET_CONFIG_API_H_
00037 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif
00041 
00042 #include "ns_types.h"
00043 
00044 /**
00045   * \brief function callback type for nd_data_request.
00046   *
00047   * \param inteface_id Network interface ID where request was made.
00048   * \param status 0 when response is received from destination, -1 otherwise.
00049   * \param data_ptr ND_data options encoded according to RFC6106. Is NULL if destination was unreachable or didn't have the requested data.
00050   * \param data_len Length of data in bytes.
00051  */
00052 typedef void thread_net_config_nd_data_req_cb(int8_t interface_id, int8_t status, uint8_t *data_ptr, uint16_t data_len);
00053 
00054 /**
00055  * \brief Request ND options (as in RFC6106) from given destination.
00056  * Response data will be provided in callback function.
00057  *
00058  * \param interface_id network interface ID.
00059  * \param destination IPv6 address where request is sent.
00060  * \param options requested option type identifiers according to RFC6106.
00061  * \param options_len number of options requested.
00062  * \param callback Function that will be called once information is available.
00063  *
00064  * \return 0 on success. A callback will be called with/without response data.
00065  * \return <0 in error cases. Callback will not be called.
00066  */
00067 int thread_net_config_nd_data_request(int8_t interface_id, const uint8_t destination[16], const uint8_t *options, uint8_t options_len, thread_net_config_nd_data_req_cb *callback);
00068 
00069 #ifdef __cplusplus
00070 }
00071 #endif
00072 #endif /* _THREAD_NET_CONFIG_API_H_ */