structure and function definitions for lwres calls

lib/lwres/include/lwres/lwres.h

@@ -0,0 +1,159 @@
+/*
+ * Copyright (C) 1999, 2000  Internet Software Consortium.
+ * 
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
+ * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
+ * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ * SOFTWARE.
+ */
+
+#ifndef LWRES_LWRES_H
+#define LWRES_LWRES_H 1
+
+#include <stddef.h>
+
+#include <isc/lang.h>
+#include <isc/int.h>
+
+#define LWRES_OPCODE_NOOP		0x00000000U
+typedef struct {
+	/* public */
+	isc_uint32_t		result;
+	unsigned int		buflen;
+	void		       *buffer;  /* must be last to keep alignment */
+} lwres_noop_t;
+
+
+typedef struct {
+	unsigned int		family;
+	unsigned int		length;
+	unsigned char	       *address;
+} lwres_addr_t;
+
+#define LWRES_OPCODE_GETADDRSBYNAME	0x00010001U
+typedef struct {
+	/* public */
+	isc_uint32_t		result;
+	unsigned char	       *real_name;
+	unsigned int		naliases;
+	unsigned char	      **aliases;
+	unsigned int		naddrs;
+	lwres_addr_t	      **addrs;
+	/* private */
+	unsigned int		buflen;
+	void		       *buffer;  /* must be last to keep alignment */
+	/* variable length data follows */
+} lwres_getaddrsbyname_t;
+
+#define LWRES_OPCODE_GETNAMEBYADDR	0x00010002U
+typedef struct {
+	/* public */
+	isc_uint32_t		result;
+	unsigned char	       *real_name;
+	unsgiend int		naliases;
+	unsigned char	      **aliases;
+	/* private */
+	unsigned int		buflen;
+	void		       *buffer;  /* must be last to keep alignment */
+	/* variable length data follows */
+} lwres_getnamebyaddr_t;
+
+#define LWRES_ADDRTYPE_V4		0x00000001U	/* ipv4 */
+#define LWRES_ADDRTYPE_V6		0x00000002U	/* ipv6 */
+
+ISC_LANG_BEGINDECLS
+
+unsigned int
+lwres_getaddrsbyname(unsigned char *name, unsigned int addrtypes,
+		     lwres_getaddrsbyname_t **structp);
+/*
+ * Makes a lwres call to look up all addresses associated with "name".
+ *
+ * Requires:
+ *
+ *	structp != NULL && *structp == NULL.
+ *
+ *	name != NULL, and be a null-terminated string.
+ *
+ *	addrtypes be a bitmask of the LWRES_ADDRTYPE_* constants representing
+ *	the type of addresses wanted.
+ *
+ * Returns:
+ *
+ *	Returns 0 on success, non-zero on failure.
+ *
+ *	On successful return, *structp will be non-NULL, and will point to
+ *	an allocated structure returning the data requested.  This structure
+ *	must be freed using lwres_freegetaddrsbyname() when it is no longer
+ *	needed.
+ */
+
+void
+lwres_freegetaddrsbyname(lwres_getaddrsbyname_t **structp);
+/*
+ * Frees any dynamically allocated memory for this structure.
+ *
+ * Requires:
+ *
+ *	structp != NULL && *structp != NULL.
+ *
+ * Ensures:
+ *
+ *	*structp == NULL.
+ *
+ *	All memory allocated by this structure will be returned to the
+ *	system via free().
+ */
+
+unsigned int
+lwres_getnamebyaddr(unsigned int addrlen, unsigned char *addr,
+		    unsigned int addrtype, lwres_getnamebyaddr_t **structp);
+/*
+ * Makes a lwres call to look up the hostnames associated with the address.
+ *
+ * Requires:
+ *
+ *	structp != NULL && *structp == NULL.
+ *
+ *	addr != NULL, and points to an address of length "addrlen"
+ *
+ *	addrtype have exactly one bit set, from the LWRES_ADDRTYPE_* constants.
+ *
+ * Returns:
+ *
+ *	Returns 0 on success, non-zero on failure.
+ *
+ *	On successful return, *structp will be non-NULL, and will point to
+ *	an allocated structure returning the data requested.  This structure
+ *	must be freed using lwres_freegetnamebyaddr() when it is no longer
+ *	needed.
+ */
+
+void
+lwres_freegetnamebyaddr(lwres_getaddrbyname_t **structp);
+/*
+ * Frees any dynamically allocated memory for this structure.
+ *
+ * Requires:
+ *
+ *	structp != NULL && *structp != NULL.
+ *
+ * Ensures:
+ *
+ *	*structp == NULL.
+ *
+ *	All memory allocated by this structure will be returned to the
+ *	system via free().
+ */
+
+ISC_LANG_ENDDECLS
+
+#endif /* LWRES_LWRES_H */