chiark / gitweb /
manager: print ephemeral information about running jobs' timeouts
[elogind.git] / src / systemd / sd-resolve.h
index 2023f11e7294eebf76ee0f81ad510ddb00c3f4e6..2779db036b60f22a56f15cf5b7073301408deb0d 100644 (file)
@@ -33,7 +33,7 @@ _SD_BEGIN_DECLARATIONS;
  *
  * \section moo Method of operation
  *
- * To use sd-resolve allocate an sd_resolve_t object with
+ * To use sd-resolve allocate an sd_resolve object with
  * sd_resolve_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_resolve_getaddrinfo() and
@@ -45,36 +45,36 @@ _SD_BEGIN_DECLARATIONS;
  */
 
 /** An opaque sd-resolve session structure */
-typedef struct sd_resolve sd_resolve_t;
+typedef struct sd_resolve sd_resolve;
 
 /** An opaque sd-resolve query structure */
-typedef struct sd_resolve_query sd_resolve_query_t;
+typedef struct sd_resolve_query sd_resolve_query;
 
 /** Allocate a new sd-resolve session with n_proc worker processes/threads */
-sd_resolve_t* sd_resolve_new(unsigned n_proc);
+sd_resolve* sd_resolve_new(unsigned n_proc);
 
 /** Free a sd-resolve session. This destroys all attached
- * sd_resolve_query_t objects automatically */
-void sd_resolve_free(sd_resolve_t *resolve);
+ * sd_resolve_query objects automatically */
+void sd_resolve_free(sd_resolve *resolve);
 
 /** Return the UNIX file descriptor to select() for readability
  * on. Use this function to integrate sd-resolve with your custom main
  * loop. */
-int sd_resolve_fd(sd_resolve_t *resolve);
+int sd_resolve_fd(sd_resolve *resolve);
 
 /** Process pending responses. After this function is called you can
- * get the next completed query object(s) using sd_resolve_getnext(). If
+ * get the next completed query object(s) using sd_resolve_get_next(). 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_resolve_wait(sd_resolve_t *resolve, int block);
+int sd_resolve_wait(sd_resolve *resolve, 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_resolve_getaddrinfo_done().*/
-sd_resolve_query_t* sd_resolve_getaddrinfo(sd_resolve_t *resolve, const char *node, const char *service, const struct addrinfo *hints);
+sd_resolve_query* sd_resolve_getaddrinfo(sd_resolve *resolve, const char *node, const char *service, const struct addrinfo *hints);
 
 /** Retrieve the results of a preceding sd_resolve_getaddrinfo()
  * call. Returns a addrinfo structure and a return value compatible
@@ -83,7 +83,7 @@ sd_resolve_query_t* sd_resolve_getaddrinfo(sd_resolve_t *resolve, const char *no
  * returned addrinfo structure with sd_resolve_freeaddrinfo() and not
  * libc's freeaddrinfo(3)! If the query is not completed yet EAI_AGAIN
  * is returned.*/
-int sd_resolve_getaddrinfo_done(sd_resolve_t *resolve, sd_resolve_query_t* q, struct addrinfo **ret_res);
+int sd_resolve_getaddrinfo_done(sd_resolve *resolve, sd_resolve_query* 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
@@ -91,26 +91,26 @@ int sd_resolve_getaddrinfo_done(sd_resolve_t *resolve, sd_resolve_query_t* q, st
  * query is completed you may retrieve the results using
  * sd_resolve_getnameinfo_done(). Set gethost (resp. getserv) to non-zero
  * if you want to query the hostname (resp. the service name). */
-sd_resolve_query_t* sd_resolve_getnameinfo(sd_resolve_t *resolve, const struct sockaddr *sa, socklen_t salen, int flags, int gethost, int getserv);
+sd_resolve_query* sd_resolve_getnameinfo(sd_resolve *resolve, const struct sockaddr *sa, socklen_t salen, int flags, int gethost, int getserv);
 
 /** Retrieve the results of a preceding sd_resolve_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_resolve_getnameinfo_done(sd_resolve_t *resolve, sd_resolve_query_t* q, char *ret_host, size_t hostlen, char *ret_serv, size_t servlen);
+int sd_resolve_getnameinfo_done(sd_resolve *resolve, sd_resolve_query* q, char *ret_host, size_t hostlen, char *ret_serv, size_t servlen);
 
 /** Issue a resolveer 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_resolve_res_done().  */
-sd_resolve_query_t* sd_resolve_res_query(sd_resolve_t *resolve, const char *dname, int class, int type);
+sd_resolve_query* sd_resolve_res_query(sd_resolve *resolve, const char *dname, int class, int type);
 
 /** Issue an resolveer 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_resolve_res_done().  */
-sd_resolve_query_t* sd_resolve_res_search(sd_resolve_t *resolve, const char *dname, int class, int type);
+sd_resolve_query* sd_resolve_res_search(sd_resolve *resolve, const char *dname, int class, int type);
 
 /** Retrieve the results of a preceding sd_resolve_res_query() or
  * resolve_res_search call.  The query object q is destroyed by this
@@ -119,39 +119,36 @@ sd_resolve_query_t* sd_resolve_res_search(sd_resolve_t *resolve, const char *dna
  * -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_resolve_freeanswer(). */
-int sd_resolve_res_done(sd_resolve_t *resolve, sd_resolve_query_t* q, unsigned char **answer);
+int sd_resolve_res_done(sd_resolve *resolve, sd_resolve_query* 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_resolve_wait() before this function will return sensible data.  */
-sd_resolve_query_t* sd_resolve_getnext(sd_resolve_t *resolve);
+sd_resolve_query* sd_resolve_get_next(sd_resolve *resolve);
 
 /** Return the number of query objects (completed or not) attached to
  * this session */
-int sd_resolve_getnqueries(sd_resolve_t *resolve);
+int sd_resolve_get_n_queries(sd_resolve *resolve);
 
 /** Cancel a currently running query. q is is destroyed by this call
  * and may not be used any futher. */
-void sd_resolve_cancel(sd_resolve_t *resolve, sd_resolve_query_t* q);
+void sd_resolve_cancel(sd_resolve *resolve, sd_resolve_query* q);
 
 /** Free the addrinfo structure as returned by
  * sd_resolve_getaddrinfo_done(). Make sure to use this functions instead
  * of the libc's freeaddrinfo()! */
 void sd_resolve_freeaddrinfo(struct addrinfo *ai);
 
-/** Free the answer data as returned by sd_resolve_res_done().*/
-void sd_resolve_freeanswer(unsigned char *answer);
-
 /** Returns non-zero when the query operation specified by q has been completed */
-int sd_resolve_isdone(sd_resolve_t *resolve, sd_resolve_query_t*q);
+int sd_resolve_isdone(sd_resolve *resolve, sd_resolve_query*q);
 
 /** Assign some opaque userdata with a query object */
-void sd_resolve_setuserdata(sd_resolve_t *resolve, sd_resolve_query_t *q, void *userdata);
+void sd_resolve_setuserdata(sd_resolve *resolve, sd_resolve_query *q, void *userdata);
 
 /** Return userdata assigned to a query object. Use
  * sd_resolve_setuserdata() to set this data. If no data has been set
  * prior to this call it returns NULL. */
-void* sd_resolve_getuserdata(sd_resolve_t *resolve, sd_resolve_query_t *q);
+void* sd_resolve_getuserdata(sd_resolve *resolve, sd_resolve_query *q);
 
 _SD_END_DECLARATIONS;