contrib/bind-9.2.4rc7/lib/dns/include/dns/peer.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2000, 2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: peer.h,v 1.16.2.2 2004/03/09 06:11:19 marka Exp $ */
  19
  20 #ifndef DNS_PEER_H
  21 #define DNS_PEER_H 1
  22
  23 /*****
  24  ***** Module Info
  25  *****/
  26
  27 /*
  28  * Data structures for peers (e.g. a 'server' config file statement)
  29  */
  30
  31 /***
  32  *** Imports
  33  ***/
  34
  35 #include <isc/lang.h>
  36 #include <isc/magic.h>
  37 #include <isc/netaddr.h>
  38
  39 #include <dns/types.h>
  40
  41 #define DNS_PEERLIST_MAGIC      ISC_MAGIC('s','e','R','L')
  42 #define DNS_PEER_MAGIC          ISC_MAGIC('S','E','r','v')
  43
  44 #define DNS_PEERLIST_VALID(ptr) ISC_MAGIC_VALID(ptr, DNS_PEERLIST_MAGIC)
  45 #define DNS_PEER_VALID(ptr)     ISC_MAGIC_VALID(ptr, DNS_PEER_MAGIC)
  46
  47 /***
  48  *** Types
  49  ***/
  50
  51 struct dns_peerlist {
  52         unsigned int            magic;
  53         isc_uint32_t            refs;
  54
  55         isc_mem_t              *mem;
  56
  57         ISC_LIST(dns_peer_t) elements;
  58 };
  59
  60 struct dns_peer {
  61         unsigned int            magic;
  62         isc_uint32_t            refs;
  63
  64         isc_mem_t              *mem;
  65
  66         isc_netaddr_t           address;
  67         isc_boolean_t           bogus;
  68         dns_transfer_format_t   transfer_format;
  69         isc_uint32_t            transfers;
  70         isc_boolean_t           support_ixfr;
  71         isc_boolean_t           provide_ixfr;
  72         isc_boolean_t           request_ixfr;
  73         isc_boolean_t           support_edns;
  74         dns_name_t             *key;
  75
  76         isc_uint32_t            bitflags;
  77
  78         ISC_LINK(dns_peer_t)    next;
  79 };
  80
  81 /***
  82  *** Functions
  83  ***/
  84
  85 ISC_LANG_BEGINDECLS
  86
  87 isc_result_t
  88 dns_peerlist_new(isc_mem_t *mem, dns_peerlist_t **list);
  89
  90 void
  91 dns_peerlist_attach(dns_peerlist_t *source, dns_peerlist_t **target);
  92
  93 void
  94 dns_peerlist_detach(dns_peerlist_t **list);
  95
  96 /*
  97  * After return caller still holds a reference to peer.
  98  */
  99 void
 100 dns_peerlist_addpeer(dns_peerlist_t *peers, dns_peer_t *peer);
 101
 102 /*
 103  * Ditto. */
 104 isc_result_t
 105 dns_peerlist_peerbyaddr(dns_peerlist_t *peers, isc_netaddr_t *addr,
 106                         dns_peer_t **retval);
 107
 108 /*
 109  * What he said.
 110  */
 111 isc_result_t
 112 dns_peerlist_currpeer(dns_peerlist_t *peers, dns_peer_t **retval);
 113
 114 isc_result_t
 115 dns_peer_new(isc_mem_t *mem, isc_netaddr_t *ipaddr, dns_peer_t **peer);
 116
 117 isc_result_t
 118 dns_peer_attach(dns_peer_t *source, dns_peer_t **target);
 119
 120 isc_result_t
 121 dns_peer_detach(dns_peer_t **list);
 122
 123 isc_result_t
 124 dns_peer_setbogus(dns_peer_t *peer, isc_boolean_t newval);
 125
 126 isc_result_t
 127 dns_peer_getbogus(dns_peer_t *peer, isc_boolean_t *retval);
 128
 129 isc_result_t
 130 dns_peer_setrequestixfr(dns_peer_t *peer, isc_boolean_t newval);
 131
 132 isc_result_t
 133 dns_peer_getrequestixfr(dns_peer_t *peer, isc_boolean_t *retval);
 134
 135 isc_result_t
 136 dns_peer_setprovideixfr(dns_peer_t *peer, isc_boolean_t newval);
 137
 138 isc_result_t
 139 dns_peer_getprovideixfr(dns_peer_t *peer, isc_boolean_t *retval);
 140
 141 isc_result_t
 142 dns_peer_setsupportedns(dns_peer_t *peer, isc_boolean_t newval);
 143
 144 isc_result_t
 145 dns_peer_getsupportedns(dns_peer_t *peer, isc_boolean_t *retval);
 146
 147 isc_result_t
 148 dns_peer_settransfers(dns_peer_t *peer, isc_uint32_t newval);
 149
 150 isc_result_t
 151 dns_peer_gettransfers(dns_peer_t *peer, isc_uint32_t *retval);
 152
 153 isc_result_t
 154 dns_peer_settransferformat(dns_peer_t *peer, dns_transfer_format_t newval);
 155
 156 isc_result_t
 157 dns_peer_gettransferformat(dns_peer_t *peer, dns_transfer_format_t *retval);
 158
 159 isc_result_t
 160 dns_peer_setkeybycharp(dns_peer_t *peer, const char *keyval);
 161
 162 isc_result_t
 163 dns_peer_getkey(dns_peer_t *peer, dns_name_t **retval);
 164
 165 isc_result_t
 166 dns_peer_setkey(dns_peer_t *peer, dns_name_t **keyval);
 167
 168 ISC_LANG_ENDDECLS
 169
 170 #endif /* DNS_PEER_H */