2 * Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000, 2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or 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.
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.
18 /* $Id: context.h,v 1.23 2008/12/17 23:47:58 tbox Exp $ */
20 #ifndef LWRES_CONTEXT_H
21 #define LWRES_CONTEXT_H 1
23 /*! \file lwres/context.h */
27 #include <lwres/lang.h>
28 #include <lwres/int.h>
29 #include <lwres/result.h>
32 * Used to set various options such as timeout, authentication, etc
34 typedef struct lwres_context lwres_context_t;
38 typedef void *(*lwres_malloc_t)(void *arg, size_t length);
39 typedef void (*lwres_free_t)(void *arg, void *mem, size_t length);
44 * Make the server reload /etc/resolv.conf periodically.
46 * Make the server do sortlist/searchlist.
48 * Client side can disable the search/sortlist processing.
50 * Use an array of addresses/masks and searchlist for client-side, and
51 * if added to the client disable the processing on the server.
53 * Share /etc/resolv.conf data between contexts.
58 * Don't allocate and connect a socket to the server, since the
59 * caller _is_ a server.
62 * Use IPv4 and IPv6 transactions with remote servers, respectively.
63 * For backward compatibility, regard both flags as being set when both
66 #define LWRES_CONTEXT_SERVERMODE 0x00000001U
67 #define LWRES_CONTEXT_USEIPV4 0x00000002U
68 #define LWRES_CONTEXT_USEIPV6 0x00000004U
71 lwres_context_create(lwres_context_t **contextp, void *arg,
72 lwres_malloc_t malloc_function,
73 lwres_free_t free_function,
76 * Allocate a lwres context. This is used in all lwres calls.
78 * Memory management can be replaced here by passing in two functions.
79 * If one is non-NULL, they must both be non-NULL. "arg" is passed to
82 * Contexts are not thread safe. Document at the top of the file.
85 * If they are NULL, the standard malloc() and free() will be used.
87 *\pre contextp != NULL && contextp == NULL.
89 *\return Returns 0 on success, non-zero on failure.
93 lwres_context_destroy(lwres_context_t **contextp);
95 * Frees all memory associated with a lwres context.
97 *\pre contextp != NULL && contextp == NULL.
101 lwres_context_nextserial(lwres_context_t *ctx);
107 lwres_context_initserial(lwres_context_t *ctx, lwres_uint32_t serial);
110 lwres_context_freemem(lwres_context_t *ctx, void *mem, size_t len);
113 lwres_context_allocmem(lwres_context_t *ctx, size_t len);
116 lwres_context_getsocket(lwres_context_t *ctx);
119 lwres_context_send(lwres_context_t *ctx,
120 void *sendbase, int sendlen);
123 lwres_context_recv(lwres_context_t *ctx,
124 void *recvbase, int recvlen,
128 lwres_context_sendrecv(lwres_context_t *ctx,
129 void *sendbase, int sendlen,
130 void *recvbase, int recvlen,
135 #endif /* LWRES_CONTEXT_H */