2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_client_lib.h
23 * @brief functions related to accessing services
24 * @author Christian Grothoff
27 #ifndef GNUNET_CLIENT_LIB_H
28 #define GNUNET_CLIENT_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_common.h"
39 #include "gnunet_configuration_lib.h"
40 #include "gnunet_connection_lib.h"
41 #include "gnunet_scheduler_lib.h"
42 #include "gnunet_time_lib.h"
45 * Opaque handle for a connection to a service.
47 struct GNUNET_CLIENT_Connection;
50 * Get a connection with a service.
52 * @param service_name name of the service
53 * @param cfg configuration to use
54 * @return NULL on error (service unknown to configuration)
56 struct GNUNET_CLIENT_Connection *
57 GNUNET_CLIENT_connect (const char *service_name,
58 const struct GNUNET_CONFIGURATION_Handle *cfg);
62 * Configure this connection to ignore shutdown signals.
64 * @param h client handle
65 * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
68 GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
74 * Destroy connection with the service. This will automatically
75 * cancel any pending "receive" request (however, the handler will
76 * *NOT* be called, not even with a NULL message). Any pending
77 * transmission request will also be cancelled UNLESS the callback for
78 * the transmission request has already been called, in which case the
79 * transmission 'finish_pending_write' argument determines whether or
80 * not the write is guaranteed to complete before the socket is fully
81 * destroyed (unless, of course, there is an error with the server in
82 * which case the message may still be lost).
84 * @param sock handle to the service connection
85 * @param finish_pending_write should a transmission already passed to the
86 * handle be completed?
89 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
90 int finish_pending_write);
93 * Type of a function to call when we receive a message
97 * @param msg message received, NULL on timeout or fatal error
99 typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
100 const struct GNUNET_MessageHeader
104 * Type of a function to call when we have finished shutting
105 * down a service, or failed.
108 * @param reason what is the result of the shutdown
109 * GNUNET_NO on shutdown (not running)
110 * GNUNET_YES on running
111 * GNUNET_SYSERR on failure to transmit message
113 typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls, int reason);
116 * Read from the service.
118 * @param sock the service
119 * @param handler function to call with the message
120 * @param handler_cls closure for handler
121 * @param timeout how long to wait until timing out
124 GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *sock,
125 GNUNET_CLIENT_MessageHandler handler, void *handler_cls,
126 struct GNUNET_TIME_Relative timeout);
130 * Transmit handle for client connections.
132 struct GNUNET_CLIENT_TransmitHandle;
136 * Ask the client to call us once the specified number of bytes
137 * are free in the transmission buffer. May call the notify
138 * method immediately if enough space is available.
140 * @param sock connection to the service
141 * @param size number of bytes to send
142 * @param timeout after how long should we give up (and call
143 * notify with buf NULL and size 0)?
144 * @param auto_retry if the connection to the service dies, should we
145 * automatically re-connect and retry (within the timeout period)
146 * or should we immediately fail in this case? Pass GNUNET_YES
147 * if the caller does not care about temporary connection errors,
148 * for example because the protocol is stateless
149 * @param notify function to call
150 * @param notify_cls closure for notify
151 * @return NULL if someone else is already waiting to be notified
152 * non-NULL if the notify callback was queued (can be used to cancel
153 * using GNUNET_CONNECTION_notify_transmit_ready_cancel)
155 struct GNUNET_CLIENT_TransmitHandle *
156 GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *sock,
158 struct GNUNET_TIME_Relative timeout,
160 GNUNET_CONNECTION_TransmitReadyNotify
161 notify, void *notify_cls);
165 * Cancel a request for notification.
167 * @param th handle from the original request.
170 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle
175 * Convenience API that combines sending a request
176 * to the service and waiting for a response.
177 * If either operation times out, the callback
178 * will be called with a "NULL" response (in which
179 * case the connection should probably be destroyed).
181 * @param sock connection to use
182 * @param hdr message to transmit
183 * @param timeout when to give up (for both transmission
184 * and for waiting for a response)
185 * @param auto_retry if the connection to the service dies, should we
186 * automatically re-connect and retry (within the timeout period)
187 * or should we immediately fail in this case? Pass GNUNET_YES
188 * if the caller does not care about temporary connection errors,
189 * for example because the protocol is stateless
190 * @param rn function to call with the response
191 * @param rn_cls closure for rn
192 * @return GNUNET_OK on success, GNUNET_SYSERR if a request
196 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *sock,
197 const struct GNUNET_MessageHeader *hdr,
198 struct GNUNET_TIME_Relative timeout,
200 GNUNET_CLIENT_MessageHandler rn,
205 * Wait until the service is running.
207 * @param service name of the service to wait for
208 * @param cfg configuration to use
209 * @param timeout how long to wait at most in ms
210 * @param task task to run if service is running
211 * (reason will be "PREREQ_DONE" (service running)
212 * or "TIMEOUT" (service not known to be running))
213 * @param task_cls closure for task
216 GNUNET_CLIENT_service_test (const char *service,
217 const struct GNUNET_CONFIGURATION_Handle *cfg,
218 struct GNUNET_TIME_Relative timeout,
219 GNUNET_SCHEDULER_Task task, void *task_cls);
222 #if 0 /* keep Emacsens' auto-indent happy */
229 /* ifndef GNUNET_CLIENT_LIB_H */
231 /* end of gnunet_client_lib.h */