thread_mdns.h

00001 /*
00002  * Copyright (c) 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  * \brief Thread mDNS responser. This module implements Thread specific MDNS-SD functionality
00032  * by using mDNS responder available in Nanostack.
00033  *
00034  */
00035 
00036 #ifndef __THREAD_MDNS_H__
00037 #define __THREAD_MDNS_H__
00038 
00039 /**
00040  * \brief Start Thread mDNS responder
00041  *
00042  * \param interface_id Thread Network interface ID.
00043  * \param interface_id_mdns Interface ID where mDNS messaging occurs.
00044  * \param service_name Name of the instance
00045  *
00046  * \return 0 on success, negative value on error
00047   */
00048 int thread_mdns_start(int8_t interface_id, int8_t interface_id_mdns, const char *service_name);
00049 
00050 /**
00051  * \brief Stop Thread mDNS responder
00052  *
00053  * \return 0 on success, negative value on error
00054  */
00055 int thread_mdns_stop(void);
00056 
00057 /**
00058  * \brief Notify Thread mDNS responser that network data has been changed
00059  *
00060  */
00061 void thread_mdns_network_data_update_notify(void);
00062 
00063 #endif // __THREAD_MDNS_H__
00064