git.meshlink.io Git - catta/blob - avahi-core/core.h

   1 #ifndef foocorehfoo
   2 #define foocorehfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of avahi.
   8
   9   avahi is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, or (at your option) any later version.
  13
  14   avahi is distributed in the hope that it will be useful, but WITHOUT
  15   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  16   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  17   Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License along with avahi; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 /** \file core.h The Avahi Multicast DNS and DNS Service Discovery implementation. */
  26
  27
  28 #include <avahi-common/cdecl.h>
  29
  30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  31 AVAHI_C_DECL_BEGIN
  32 #endif
  33
  34 /** An mDNS responder object */
  35 typedef struct AvahiServer AvahiServer;
  36
  37 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  38 AVAHI_C_DECL_END
  39 #endif
  40
  41 #include <avahi-core/rr.h>
  42 #include <avahi-common/address.h>
  43 #include <avahi-common/defs.h>
  44 #include <avahi-common/watch.h>
  45
  46 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  47 AVAHI_C_DECL_BEGIN
  48 #endif
  49
  50 /** Maximum number of defined DNS servers for wide area DNS */
  51 #define AVAHI_WIDE_AREA_SERVERS_MAX 4
  52
  53 /** Prototype for callback functions which are called whenever the state of an AvahiServer object changes */
  54 typedef void (*AvahiServerCallback) (AvahiServer *s, AvahiServerState state, void* userdata);
  55
  56 /** Stores configuration options for a server instance */
  57 typedef struct AvahiServerConfig {
  58     char *host_name;                  /**< Default host name. If left empty defaults to the result of gethostname(2) of the libc */
  59     char *domain_name;                /**< Default domain name. If left empty defaults to .local */
  60     int use_ipv4;                     /**< Enable IPv4 support */
  61     int use_ipv6;                     /**< Enable IPv6 support */
  62     int publish_hinfo;                /**< Register a HINFO record for the host containing the local OS and CPU type */
  63     int publish_addresses;            /**< Register A, AAAA and PTR records for all local IP addresses */
  64     int publish_workstation;          /**< Register a _workstation._tcp service */
  65     int publish_domain;               /**< Announce the local domain for browsing */
  66     int check_response_ttl;           /**< If enabled the server ignores all incoming responses with IP TTL != 255. Newer versions of the RFC do no longer contain this check, so it is disabled by default. */
  67     int use_iff_running;              /**< Require IFF_RUNNING on local network interfaces. This is the official way to check for link beat. Unfortunately this doesn't work with all drivers. So bettere leave this off. */
  68     int enable_reflector;             /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */
  69     int reflect_ipv;                  /**< if enable_reflector is 1, enable/disable reflecting between IPv4 and IPv6 */
  70     int add_service_cookie;           /**< Add magic service cookie to all locally generated records implicitly */
  71     int enable_wide_area;             /**< Enable wide area support */
  72     AvahiAddress wide_area_servers[AVAHI_WIDE_AREA_SERVERS_MAX]; /** Unicast DNS server to use for wide area lookup */
  73     unsigned n_wide_area_servers;     /**< Number of servers in wide_area_servers[] */
  74     int disallow_other_stacks;        /**< Make sure that only one mDNS responder is run at the same time on the local machine. If this is enable Avahi will not set SO_REUSADDR on its sockets, effectively preventing other stacks from running on the local machine */
  75 } AvahiServerConfig;
  76
  77 /** Allocate a new mDNS responder object. */
  78 AvahiServer *avahi_server_new(
  79     const AvahiPoll *api,          /**< The main loop adapter */
  80     const AvahiServerConfig *sc,   /**< If non-NULL a pointer to a configuration structure for the server. The server makes an internal deep copy of this structure, so you may free it using avahi_server_config_done() immediately after calling this function. */
  81     AvahiServerCallback callback,  /**< A callback which is called whenever the state of the server changes */
  82     void* userdata,                /**< An opaque pointer which is passed to the callback function */
  83     int *error);
  84
  85 /** Free an mDNS responder object */
  86 void avahi_server_free(AvahiServer* s);
  87
  88 /** Fill in default values for a server configuration structure. If you
  89  * make use of an AvahiServerConfig structure be sure to initialize
  90  * it with this function for the sake of upwards library
  91  * compatibility. This call may allocate strings on the heap. To
  92  * release this memory make sure to call
  93  * avahi_server_config_done(). If you want to replace any strings in
  94  * the structure be sure to free the strings filled in by this
  95  * function with avahi_free() first and allocate the replacements with
  96  * g_malloc() (or g_strdup()).*/
  97 AvahiServerConfig* avahi_server_config_init(
  98    AvahiServerConfig *c /**< A structure which shall be filled in */ );
  99
 100 /** Make a deep copy of the configuration structure *c to *ret. */
 101 AvahiServerConfig* avahi_server_config_copy(
 102     AvahiServerConfig *ret /**< destination */,
 103     const AvahiServerConfig *c /**< source */);
 104
 105 /** Free the data in a server configuration structure. */
 106 void avahi_server_config_free(AvahiServerConfig *c);
 107
 108 /** Return the currently chosen domain name of the server object. The
 109  * return value points to an internally allocated string. Be sure to
 110  * make a copy of the string before calling any other library
 111  * functions. */
 112 const char* avahi_server_get_domain_name(AvahiServer *s);
 113
 114 /** Return the currently chosen host name. The return value points to a internally allocated string. */
 115 const char* avahi_server_get_host_name(AvahiServer *s);
 116
 117 /** Return the currently chosen host name as a FQDN ("fully qualified
 118  * domain name", i.e. the concatenation of the host and domain
 119  * name). The return value points to a internally allocated string. */
 120 const char* avahi_server_get_host_name_fqdn(AvahiServer *s);
 121
 122 /** Change the host name of a running mDNS responder. This will drop
 123 all automicatilly generated RRs and readd them with the new
 124 name. Since the responder has to probe for the new RRs this function
 125 takes some time to take effect altough it returns immediately. This
 126 function is intended to be called when a host name conflict is
 127 reported using AvahiServerCallback. The caller should readd all user
 128 defined RRs too since they otherwise continue to point to the outdated
 129 host name..*/
 130 int avahi_server_set_host_name(AvahiServer *s, const char *host_name);
 131
 132 /** Change the domain name of a running mDNS responder. The same rules
 133  * as with avahi_server_set_host_name() apply. */
 134 int avahi_server_set_domain_name(AvahiServer *s, const char *domain_name);
 135
 136 /** Return the opaque user data pointer attached to a server object */
 137 void* avahi_server_get_data(AvahiServer *s);
 138
 139 /** Change the opaque user data pointer attached to a server object */
 140 void avahi_server_set_data(AvahiServer *s, void* userdata);
 141
 142 /** Return the current state of the server object */
 143 AvahiServerState avahi_server_get_state(AvahiServer *s);
 144
 145 /** Callback prototype for avahi_server_dump() */
 146 typedef void (*AvahiDumpCallback)(const char *text, void* userdata);
 147
 148 /** Dump the current server status by calling "callback" for each line.  */
 149 int avahi_server_dump(AvahiServer *s, AvahiDumpCallback callback, void* userdata);
 150
 151 /** Return the last error code */
 152 int avahi_server_errno(AvahiServer *s);
 153
 154 /** Return the local service cookie */
 155 uint32_t avahi_server_get_local_service_cookie(AvahiServer *s);
 156
 157 /** Set the wide area DNS servers */
 158 int avahi_server_set_wide_area_servers(AvahiServer *s, const AvahiAddress *a, unsigned n);
 159
 160 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 161 AVAHI_C_DECL_END
 162 #endif
 163
 164 #endif