chiark / gitweb /
sd-resolv: rename to sd-resolve
[elogind.git] / src / systemd / sd-resolv.h
diff --git a/src/systemd/sd-resolv.h b/src/systemd/sd-resolv.h
deleted file mode 100644 (file)
index 21e2413..0000000
+++ /dev/null
@@ -1,158 +0,0 @@
-/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
-
-#ifndef foosdresolvhfoo
-#define foosdresolvhfoo
-
-/***
-  This file is part of systemd.
-
-  Copyright 2005-2008 Lennart Poettering
-
-  systemd 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.
-
-  systemd 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 systemd; If not, see <http://www.gnu.org/licenses/>.
-***/
-
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netdb.h>
-#include "_sd-common.h"
-
-_SD_BEGIN_DECLARATIONS;
-
-/** \mainpage
- *
- * \section moo Method of operation
- *
- * To use libresolv allocate an sd_resolv_t object with
- * sd_resolv_new(). This will spawn a number of worker threads (or processes, depending on what is available) which
- * are subsequently used to process the queries the controlling
- * program issues via sd_resolv_getaddrinfo() and
- * sd_resolv_getnameinfo(). Use sd_resolv_free() to shut down the worker
- * threads/processes.
- *
- * Since libresolv may fork off new processes you have to make sure that
- * your program is not irritated by spurious SIGCHLD signals.
- */
-
-/** An opaque libresolv session structure */
-typedef struct sd_resolv sd_resolv_t;
-
-/** An opaque libresolv query structure */
-typedef struct sd_resolv_query sd_resolv_query_t;
-
-/** Allocate a new libresolv session with n_proc worker processes/threads */
-sd_resolv_t* sd_resolv_new(unsigned n_proc);
-
-/** Free a libresolv session. This destroys all attached
- * sd_resolv_query_t objects automatically */
-void sd_resolv_free(sd_resolv_t *resolv);
-
-/** Return the UNIX file descriptor to select() for readability
- * on. Use this function to integrate libresolv with your custom main
- * loop. */
-int sd_resolv_fd(sd_resolv_t *resolv);
-
-/** Process pending responses. After this function is called you can
- * get the next completed query object(s) using sd_resolv_getnext(). If
- * block is non-zero wait until at least one response has been
- * processed. If block is zero, process all pending responses and
- * return. */
-int sd_resolv_wait(sd_resolv_t *resolv, int block);
-
-/** Issue a name to address query on the specified session. The
- * arguments are compatible with the ones of libc's
- * getaddrinfo(3). The function returns a new query object. When the
- * query is completed you may retrieve the results using
- * sd_resolv_getaddrinfo_done().*/
-sd_resolv_query_t* sd_resolv_getaddrinfo(sd_resolv_t *resolv, const char *node, const char *service, const struct addrinfo *hints);
-
-/** Retrieve the results of a preceding sd_resolv_getaddrinfo()
- * call. Returns a addrinfo structure and a return value compatible
- * with libc's getaddrinfo(3). The query object q is destroyed by this
- * call and may not be used any further. Make sure to free the
- * returned addrinfo structure with sd_resolv_freeaddrinfo() and not
- * libc's freeaddrinfo(3)! If the query is not completed yet EAI_AGAIN
- * is returned.*/
-int sd_resolv_getaddrinfo_done(sd_resolv_t *resolv, sd_resolv_query_t* q, struct addrinfo **ret_res);
-
-/** Issue an address to name query on the specified session. The
- * arguments are compatible with the ones of libc's
- * getnameinfo(3). The function returns a new query object. When the
- * query is completed you may retrieve the results using
- * sd_resolv_getnameinfo_done(). Set gethost (resp. getserv) to non-zero
- * if you want to query the hostname (resp. the service name). */
-sd_resolv_query_t* sd_resolv_getnameinfo(sd_resolv_t *resolv, const struct sockaddr *sa, socklen_t salen, int flags, int gethost, int getserv);
-
-/** Retrieve the results of a preceding sd_resolv_getnameinfo()
- * call. Returns the hostname and the service name in ret_host and
- * ret_serv. The query object q is destroyed by this call and may not
- * be used any further. If the query is not completed yet EAI_AGAIN is
- * returned. */
-int sd_resolv_getnameinfo_done(sd_resolv_t *resolv, sd_resolv_query_t* q, char *ret_host, size_t hostlen, char *ret_serv, size_t servlen);
-
-/** Issue a resolver query on the specified session. The arguments are
- * compatible with the ones of libc's res_query(3). The function returns a new
- * query object. When the query is completed you may retrieve the results using
- * sd_resolv_res_done().  */
-sd_resolv_query_t* sd_resolv_res_query(sd_resolv_t *resolv, const char *dname, int class, int type);
-
-/** Issue an resolver query on the specified session. The arguments are
- * compatible with the ones of libc's res_search(3). The function returns a new
- * query object. When the query is completed you may retrieve the results using
- * sd_resolv_res_done().  */
-sd_resolv_query_t* sd_resolv_res_search(sd_resolv_t *resolv, const char *dname, int class, int type);
-
-/** Retrieve the results of a preceding sd_resolv_res_query() or
- * resolv_res_search call.  The query object q is destroyed by this
- * call and may not be used any further. Returns a pointer to the
- * answer of the res_query call. If the query is not completed yet
- * -EAGAIN is returned, on failure -errno is returned, otherwise the
- * length of answer is returned. Make sure to free the answer is a
- * call to sd_resolv_freeanswer(). */
-int sd_resolv_res_done(sd_resolv_t *resolv, sd_resolv_query_t* q, unsigned char **answer);
-
-/** Return the next completed query object. If no query has been
- * completed yet, return NULL. Please note that you need to run
- * sd_resolv_wait() before this function will return sensible data.  */
-sd_resolv_query_t* sd_resolv_getnext(sd_resolv_t *resolv);
-
-/** Return the number of query objects (completed or not) attached to
- * this session */
-int sd_resolv_getnqueries(sd_resolv_t *resolv);
-
-/** Cancel a currently running query. q is is destroyed by this call
- * and may not be used any futher. */
-void sd_resolv_cancel(sd_resolv_t *resolv, sd_resolv_query_t* q);
-
-/** Free the addrinfo structure as returned by
- * sd_resolv_getaddrinfo_done(). Make sure to use this functions instead
- * of the libc's freeaddrinfo()! */
-void sd_resolv_freeaddrinfo(struct addrinfo *ai);
-
-/** Free the answer data as returned by sd_resolv_res_done().*/
-void sd_resolv_freeanswer(unsigned char *answer);
-
-/** Returns non-zero when the query operation specified by q has been completed */
-int sd_resolv_isdone(sd_resolv_t *resolv, sd_resolv_query_t*q);
-
-/** Assign some opaque userdata with a query object */
-void sd_resolv_setuserdata(sd_resolv_t *resolv, sd_resolv_query_t *q, void *userdata);
-
-/** Return userdata assigned to a query object. Use
- * sd_resolv_setuserdata() to set this data. If no data has been set
- * prior to this call it returns NULL. */
-void* sd_resolv_getuserdata(sd_resolv_t *resolv, sd_resolv_query_t *q);
-
-_SD_END_DECLARATIONS;
-
-#endif