1 /* 2 * Copyright (c) 2016-2017, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * @brief 32 * This file defines the OpenThread Server API. 33 */ 34 35 #ifndef OPENTHREAD_SERVER_H_ 36 #define OPENTHREAD_SERVER_H_ 37 38 #include <openthread/netdata.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @addtogroup api-server 46 * 47 * @brief 48 * This module includes functions to manage local network data with the OpenThread Server. 49 * 50 * @{ 51 */ 52 53 /** 54 * Provides a full or stable copy of the local Thread Network Data. 55 * 56 * @param[in] aInstance A pointer to an OpenThread instance. 57 * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. 58 * @param[out] aData A pointer to the data buffer. 59 * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. 60 * On exit, number of copied bytes. 61 */ 62 otError otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength); 63 64 /** 65 * Add a service configuration to the local network data. 66 * 67 * @param[in] aInstance A pointer to an OpenThread instance. 68 * @param[in] aConfig A pointer to the service configuration. 69 * 70 * @retval OT_ERROR_NONE Successfully added the configuration to the local network data. 71 * @retval OT_ERROR_INVALID_ARGS One or more configuration parameters were invalid. 72 * @retval OT_ERROR_NO_BUFS Not enough room is available to add the configuration to the local network data. 73 * 74 * @sa otServerRemoveService 75 * @sa otServerRegister 76 */ 77 otError otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig); 78 79 /** 80 * Remove a service configuration from the local network data. 81 * 82 * @param[in] aInstance A pointer to an OpenThread instance. 83 * @param[in] aEnterpriseNumber Enterprise Number of the service entry to be deleted. 84 * @param[in] aServiceData A pointer to an Service Data to look for during deletion. 85 * @param[in] aServiceDataLength The length of @p aServiceData in bytes. 86 * 87 * @retval OT_ERROR_NONE Successfully removed the configuration from the local network data. 88 * @retval OT_ERROR_NOT_FOUND Could not find the Border Router entry. 89 * 90 * @sa otServerAddService 91 * @sa otServerRegister 92 */ 93 otError otServerRemoveService(otInstance *aInstance, 94 uint32_t aEnterpriseNumber, 95 const uint8_t *aServiceData, 96 uint8_t aServiceDataLength); 97 98 /** 99 * Gets the next service in the local Network Data. 100 * 101 * @param[in] aInstance A pointer to an OpenThread instance. 102 * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first service entry 103 it should be set to OT_NETWORK_DATA_ITERATOR_INIT. 104 * @param[out] aConfig A pointer to where the service information will be placed. 105 * 106 * @retval OT_ERROR_NONE Successfully found the next service. 107 * @retval OT_ERROR_NOT_FOUND No subsequent service exists in the Thread Network Data. 108 */ 109 otError otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig); 110 111 /** 112 * Immediately register the local network data with the Leader. 113 * 114 * @param[in] aInstance A pointer to an OpenThread instance. 115 * 116 * @retval OT_ERROR_NONE Successfully queued a Server Data Request message for delivery. 117 * 118 * @sa otServerAddService 119 * @sa otServerRemoveService 120 */ 121 otError otServerRegister(otInstance *aInstance); 122 123 /** 124 * @} 125 */ 126 127 #ifdef __cplusplus 128 } // extern "C" 129 #endif 130 131 #endif // OPENTHREAD_SERVER_H_ 132