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

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