chiark - git - mdw - disorder/blob - lib/addr.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2007, 2008, 2013 Richard Kettlewell
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/addr.h
  19  * @brief Socket address support */
  20
  21 #ifndef ADDR_H
  22 #define ADDR_H
  23
  24 #if HAVE_NETDB_H
  25 # include <netdb.h>
  26 #endif
  27
  28 struct stringlist;
  29
  30 /** @brief A network address */
  31 struct netaddress {
  32   /** @brief Address family
  33    *
  34    * Typically @c AF_UNIX, @c AF_INET, @c AF_INET6 or @c AF_UNSPEC.
  35    * Set to -1 to mean 'no address'.
  36    */
  37   int af;
  38
  39   /** @brief Address or NULL for 'any' */
  40   char *address;
  41
  42   /** @brief Port number */
  43   int port;
  44 };
  45
  46 /** @brief A socket address and length */
  47 struct resolved {
  48
  49   /** @brief Pointer to the address */
  50   struct sockaddr *sa;
  51
  52   /** @brief Length of the address */
  53   socklen_t len;
  54 };
  55
  56 struct addrinfo *get_address(const struct stringlist *a,
  57                              const struct addrinfo *pref,
  58                              char **namep)
  59   attribute((nonnull (1)));
  60
  61 int addrinfocmp(const struct addrinfo *a,
  62                 const struct addrinfo *b) attribute((nonnull (1, 2)));
  63 int sockaddrcmp(const struct sockaddr *a,
  64                 const struct sockaddr *b) attribute((nonnull (1, 2)));
  65
  66 int multicast(const struct sockaddr *sa) attribute((nonnull (1)));
  67 char *format_sockaddr(const struct sockaddr *sa) attribute((nonnull (1)));
  68
  69 int netaddress_parse(struct netaddress *na,
  70                      int nvec,
  71                      char **vec) attribute((nonnull (1)));
  72 void netaddress_format(const struct netaddress *na,
  73                        int *nvecp,
  74                        char ***vecp) attribute((nonnull (1)));
  75 int netaddress_resolve(const struct netaddress *na, int passive, int type,
  76                        struct resolved **raddr_out, size_t *nraddr_out)
  77   attribute((nonnull (1, 4, 5)));
  78 void netaddress_free_resolved(struct resolved *raddr, size_t nraddr);
  79
  80 #endif /* ADDR_H */
  81
  82 /*
  83 Local Variables:
  84 c-basic-offset:2
  85 comment-column:40
  86 End:
  87 */