src/include/gnunet_client_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_client_lib.h
  23  * @brief functions related to accessing services
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_CLIENT_LIB_H
  28 #define GNUNET_CLIENT_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  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"
  43
  44 /**
  45  * Opaque handle for a connection to a service.
  46  */
  47 struct GNUNET_CLIENT_Connection;
  48
  49 /**
  50  * Get a connection with a service.
  51  *
  52  * @param service_name name of the service
  53  * @param cfg configuration to use
  54  * @return NULL on error (service unknown to configuration)
  55  */
  56 struct GNUNET_CLIENT_Connection *
  57 GNUNET_CLIENT_connect (const char *service_name,
  58                        const struct GNUNET_CONFIGURATION_Handle *cfg);
  59
  60
  61 /**
  62  * Configure this connection to ignore shutdown signals.
  63  *
  64  * @param h client handle
  65  * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
  66  */
  67 void
  68 GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
  69                                int do_ignore);
  70
  71
  72
  73 /**
  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).
  83  *
  84  * @param sock handle to the service connection
  85  * @param finish_pending_write should a transmission already passed to the
  86  *          handle be completed?
  87  */
  88 void
  89 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
  90                           int finish_pending_write);
  91
  92
  93 /**
  94  * Type of a function to call when we receive a message
  95  * from the service.
  96  *
  97  * @param cls closure
  98  * @param msg message received, NULL on timeout or fatal error
  99  */
 100 typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
 101                                               const struct GNUNET_MessageHeader
 102                                               * msg);
 103
 104
 105 /**
 106  * Type of a function to call when we have finished shutting
 107  * down a service, or failed.
 108  *
 109  * @param cls closure
 110  * @param reason what is the result of the shutdown
 111  *        GNUNET_NO on shutdown (not running)
 112  *        GNUNET_YES on running
 113  *        GNUNET_SYSERR on failure to transmit message
 114  */
 115 typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls, int reason);
 116
 117
 118 /**
 119  * Read from the service.
 120  *
 121  * @param sock the service
 122  * @param handler function to call with the message
 123  * @param handler_cls closure for handler
 124  * @param timeout how long to wait until timing out
 125  */
 126 void
 127 GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *sock,
 128                        GNUNET_CLIENT_MessageHandler handler, void *handler_cls,
 129                        struct GNUNET_TIME_Relative timeout);
 130
 131
 132 /**
 133  * Transmit handle for client connections.
 134  */
 135 struct GNUNET_CLIENT_TransmitHandle;
 136
 137
 138 /**
 139  * Ask the client to call us once the specified number of bytes
 140  * are free in the transmission buffer.  May call the notify
 141  * method immediately if enough space is available.
 142  *
 143  * @param sock connection to the service
 144  * @param size number of bytes to send
 145  * @param timeout after how long should we give up (and call
 146  *        notify with buf NULL and size 0)?
 147  * @param auto_retry if the connection to the service dies, should we
 148  *        automatically re-connect and retry (within the timeout period)
 149  *        or should we immediately fail in this case?  Pass GNUNET_YES
 150  *        if the caller does not care about temporary connection errors,
 151  *        for example because the protocol is stateless
 152  * @param notify function to call
 153  * @param notify_cls closure for notify
 154  * @return NULL if someone else is already waiting to be notified
 155  *         non-NULL if the notify callback was queued (can be used to cancel
 156  *         using GNUNET_CONNECTION_notify_transmit_ready_cancel)
 157  */
 158 struct GNUNET_CLIENT_TransmitHandle *
 159 GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *sock,
 160                                      size_t size,
 161                                      struct GNUNET_TIME_Relative timeout,
 162                                      int auto_retry,
 163                                      GNUNET_CONNECTION_TransmitReadyNotify
 164                                      notify, void *notify_cls);
 165
 166
 167 /**
 168  * Cancel a request for notification.
 169  *
 170  * @param th handle from the original request.
 171  */
 172 void
 173 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle
 174                                             *th);
 175
 176
 177 /**
 178  * Convenience API that combines sending a request
 179  * to the service and waiting for a response.
 180  * If either operation times out, the callback
 181  * will be called with a "NULL" response (in which
 182  * case the connection should probably be destroyed).
 183  *
 184  * @param sock connection to use
 185  * @param hdr message to transmit
 186  * @param timeout when to give up (for both transmission
 187  *         and for waiting for a response)
 188  * @param auto_retry if the connection to the service dies, should we
 189  *        automatically re-connect and retry (within the timeout period)
 190  *        or should we immediately fail in this case?  Pass GNUNET_YES
 191  *        if the caller does not care about temporary connection errors,
 192  *        for example because the protocol is stateless
 193  * @param rn function to call with the response
 194  * @param rn_cls closure for rn
 195  * @return GNUNET_OK on success, GNUNET_SYSERR if a request
 196  *         is already pending
 197  */
 198 int
 199 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *sock,
 200                                          const struct GNUNET_MessageHeader *hdr,
 201                                          struct GNUNET_TIME_Relative timeout,
 202                                          int auto_retry,
 203                                          GNUNET_CLIENT_MessageHandler rn,
 204                                          void *rn_cls);
 205
 206
 207 /**
 208  * Wait until the service is running.
 209  *
 210  * @param service name of the service to wait for
 211  * @param cfg configuration to use
 212  * @param timeout how long to wait at most in ms
 213  * @param task task to run if service is running
 214  *        (reason will be "PREREQ_DONE" (service running)
 215  *         or "TIMEOUT" (service not known to be running))
 216  * @param task_cls closure for task
 217  */
 218 void
 219 GNUNET_CLIENT_service_test (const char *service,
 220                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 221                             struct GNUNET_TIME_Relative timeout,
 222                             GNUNET_SCHEDULER_Task task, void *task_cls);
 223
 224
 225 #if 0                           /* keep Emacsens' auto-indent happy */
 226 {
 227 #endif
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 /* ifndef GNUNET_CLIENT_LIB_H */
 233 #endif
 234 /* end of gnunet_client_lib.h */