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 /** 55 * Provides a full or stable copy of the local Thread Network Data. 56 * 57 * @param[in] aInstance A pointer to an OpenThread instance. 58 * @param[in] aStable TRUE when copying the stable version, FALSE when copying the full version. 59 * @param[out] aData A pointer to the data buffer. 60 * @param[in,out] aDataLength On entry, size of the data buffer pointed to by @p aData. 61 * On exit, number of copied bytes. 62 * 63 */ 64 otError otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength); 65 66 /** 67 * Add a service configuration to the local network data. 68 * 69 * @param[in] aInstance A pointer to an OpenThread instance. 70 * @param[in] aConfig A pointer to the service configuration. 71 * 72 * @retval OT_ERROR_NONE Successfully added the configuration to the local network data. 73 * @retval OT_ERROR_INVALID_ARGS One or more configuration parameters were invalid. 74 * @retval OT_ERROR_NO_BUFS Not enough room is available to add the configuration to the local network data. 75 * 76 * @sa otServerRemoveService 77 * @sa otServerRegister 78 * 79 */ 80 otError otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig); 81 82 /** 83 * Remove a service configuration from the local network data. 84 * 85 * @param[in] aInstance A pointer to an OpenThread instance. 86 * @param[in] aEnterpriseNumber Enterprise Number of the service entry to be deleted. 87 * @param[in] aServiceData A pointer to an Service Data to look for during deletion. 88 * @param[in] aServiceDataLength The length of @p aServiceData in bytes. 89 * 90 * @retval OT_ERROR_NONE Successfully removed the configuration from the local network data. 91 * @retval OT_ERROR_NOT_FOUND Could not find the Border Router entry. 92 * 93 * @sa otServerAddService 94 * @sa otServerRegister 95 * 96 */ 97 otError otServerRemoveService(otInstance *aInstance, 98 uint32_t aEnterpriseNumber, 99 const uint8_t *aServiceData, 100 uint8_t aServiceDataLength); 101 102 /** 103 * Gets the next service in the local Network Data. 104 * 105 * @param[in] aInstance A pointer to an OpenThread instance. 106 * @param[in,out] aIterator A pointer to the Network Data iterator context. To get the first service entry 107 it should be set to OT_NETWORK_DATA_ITERATOR_INIT. 108 * @param[out] aConfig A pointer to where the service information will be placed. 109 * 110 * @retval OT_ERROR_NONE Successfully found the next service. 111 * @retval OT_ERROR_NOT_FOUND No subsequent service exists in the Thread Network Data. 112 * 113 */ 114 otError otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig); 115 116 /** 117 * Immediately register the local network data with the Leader. 118 * 119 * @param[in] aInstance A pointer to an OpenThread instance. 120 * 121 * @retval OT_ERROR_NONE Successfully queued a Server Data Request message for delivery. 122 * 123 * @sa otServerAddService 124 * @sa otServerRemoveService 125 * 126 */ 127 otError otServerRegister(otInstance *aInstance); 128 129 /** 130 * @} 131 * 132 */ 133 134 #ifdef __cplusplus 135 } // extern "C" 136 #endif 137 138 #endif // OPENTHREAD_SERVER_H_ 139
