X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-common%2Fdomain.h;h=a0dcd0fa16dcb373a5e18936f2b1deadf02ba1e1;hb=e80dfc163e06f9bd9300d096f384bf418ac3062f;hp=4e3aa55d9c3d35669c2532963ca16a76c883f62d;hpb=cb5fd7f601a158562b5ec003fecc928a720e10f3;p=catta diff --git a/avahi-common/domain.h b/avahi-common/domain.h index 4e3aa55..a0dcd0f 100644 --- a/avahi-common/domain.h +++ b/avahi-common/domain.h @@ -1,21 +1,19 @@ #ifndef foodomainhfoo #define foodomainhfoo -/* $Id$ */ - /*** This file is part of avahi. - + avahi is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. - + avahi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. - + You should have received a copy of the GNU Lesser General Public License along with avahi; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 @@ -29,9 +27,7 @@ #include -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_BEGIN -#endif /** The maximum length of a a fully escaped domain name C string. This * is calculated like this: RFC1034 mandates maximum length of FQDNs @@ -44,9 +40,11 @@ AVAHI_C_DECL_BEGIN * the string brings us to 1014. */ #define AVAHI_DOMAIN_NAME_MAX 1014 -/** Maxium size of an unescaped label */ +/** Maximum size of an unescaped label */ #define AVAHI_LABEL_MAX 64 +/** @{ \name Normalization */ + /** Normalize a domain name into canonical form. This drops trailing * dots and removes useless backslash escapes. */ char *avahi_normalize_name(const char *s, char *ret_s, size_t size); @@ -56,17 +54,19 @@ char *avahi_normalize_name(const char *s, char *ret_s, size_t size); * result! */ char *avahi_normalize_name_strdup(const char *s); -/** Return the local host name. */ -char *avahi_get_host_name(char *ret_s, size_t size); +/** @} */ -/** Return the local host name. avahi_free() the result! */ -char *avahi_get_host_name_strdup(void); +/** @{ \name Comparison */ /** Return 1 when the specified domain names are equal, 0 otherwise */ int avahi_domain_equal(const char *a, const char *b); -/** Do a binary comparison of to specified domain names, return -1, 0, or 1, depending on the order. */ -int avahi_binary_domain_cmp(const char *a, const char *b); +/** Return some kind of hash value for the domain, useful for using domains as hash table keys. */ +unsigned avahi_domain_hash(const char *name); + +/** @} */ + +/** @{ \name Escaping */ /** Read the first label from the textual domain name *name, unescape * it and write it to dest, *name is changed to point to the next label*/ @@ -75,45 +75,55 @@ char *avahi_unescape_label(const char **name, char *dest, size_t size); /** Escape the domain name in *src and write it to *ret_name */ char *avahi_escape_label(const char* src, size_t src_length, char **ret_name, size_t *ret_size); -/** Return 1 when the specified string contains a valid generic +/** @} */ + +/** @{ \name Validity Checks */ + +/** Return 1 when the specified string contains a valid generic DNS-SD * service type (i.e. a series of words starting with "_"), 0 * otherwise */ int avahi_is_valid_service_type_generic(const char *t); -/** Return 1 when the specified string contains a valid strict service - * type (i.e. consisting of only two words, the latter being either - * _udp or _tcp), 0 otherwise */ +/** Return 1 when the specified string contains a valid strict DNS-SD + * service type (i.e. consisting of only two words, the latter being + * either _udp or _tcp), 0 otherwise */ int avahi_is_valid_service_type_strict(const char *t); -/** Return 1 when the specified string contains a valid service subtype, 0 otherwise */ +/** Return 1 when the specified string contains a valid DNS-SD service + * subtype, 0 otherwise */ int avahi_is_valid_service_subtype(const char *t); -/** Return a pointer to the type section of a subtype i.e. _foo._sub._bar._tcp => _bar._tcp */ -const char *avahi_get_type_from_subtype(const char *t); - /** Return 1 when the specified string contains a valid domain name, 0 otherwise */ int avahi_is_valid_domain_name(const char *t); -/** Return 1 when the specified string contains a valid service name, 0 otherwise */ +/** Return 1 when the specified string contains a valid DNS-SD service name, 0 otherwise */ int avahi_is_valid_service_name(const char *t); /** Return 1 when the specified string contains a valid non-FQDN host name (i.e. without dots), 0 otherwise */ int avahi_is_valid_host_name(const char *t); -/** Return some kind of hash value for the domain, useful for using domains as hash table keys. */ -unsigned avahi_domain_hash(const char *name); +/** Return 1 when the specified string contains a valid FQDN host name (i.e. with more than one label and non-numerical), 0 otherwise. \since 0.6.9 */ +int avahi_is_valid_fqdn(const char *t); + +/** @} */ -/** Returns 1 if the the end labels of domain are eqal to suffix */ -int avahi_domain_ends_with(const char *domain, const char *suffix); +/** @{ \name DNS-SD service name handling */ -/** Construct a valid complete service name from a name, a type and a domain */ +/** Construct a valid complete DNS-SD service name from a name, a type and a domain */ int avahi_service_name_join(char *p, size_t size, const char *name, const char *type, const char *domain); /** Split a full service name into name, type and domain */ int avahi_service_name_split(const char *p, char *name, size_t name_size, char *type, size_t type_size, char *domain, size_t domain_size); -#ifndef DOXYGEN_SHOULD_SKIP_THIS +/** @} */ + +/** @{ \name DNS-SD Subtype handling */ + +/** Return a pointer to the type section of a subtype i.e. _foo._sub._bar._tcp => _bar._tcp */ +const char *avahi_get_type_from_subtype(const char *t); + +/** @} */ + AVAHI_C_DECL_END -#endif #endif