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 *GNUNET_CLIENT_connect (const char
  57                                                         *service_name,
  58                                                         const struct
  59                                                         GNUNET_CONFIGURATION_Handle
  60                                                         *cfg);
  61
  62
  63 /**
  64  * Configure this connection to ignore shutdown signals.
  65  *
  66  * @param h client handle
  67  * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
  68  */
  69 void GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
  70                                     int do_ignore);
  71
  72
  73
  74 /**
  75  * Destroy connection with the service.  This will automatically
  76  * cancel any pending "receive" request (however, the handler will
  77  * *NOT* be called, not even with a NULL message).  Any pending
  78  * transmission request will also be cancelled UNLESS the callback for
  79  * the transmission request has already been called, in which case the
  80  * transmission 'finish_pending_write' argument determines whether or
  81  * not the write is guaranteed to complete before the socket is fully
  82  * destroyed (unless, of course, there is an error with the server in
  83  * which case the message may still be lost).
  84  *
  85  * @param sock handle to the service connection
  86  * @param finish_pending_write should a transmission already passed to the
  87  *          handle be completed?
  88  */
  89 void GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
  90                                int finish_pending_write);
  91
  92 /**
  93  * Type of a function to call when we receive a message
  94  * from the service.
  95  *
  96  * @param cls closure
  97  * @param msg message received, NULL on timeout or fatal error
  98  */
  99 typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
 100                                               const struct GNUNET_MessageHeader
 101                                               * msg);
 102
 103 /**
 104  * Type of a function to call when we have finished shutting
 105  * down a service, or failed.
 106  *
 107  * @param cls closure
 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
 112  */
 113 typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls, int reason);
 114
 115 /**
 116  * Read from the service.
 117  *
 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
 122  */
 123 void GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *sock,
 124                             GNUNET_CLIENT_MessageHandler handler,
 125                             void *handler_cls,
 126                             struct GNUNET_TIME_Relative timeout);
 127
 128
 129 /**
 130  * Transmit handle for client connections.
 131  */
 132 struct GNUNET_CLIENT_TransmitHandle;
 133
 134
 135 /**
 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.
 139  *
 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)
 154  */
 155 struct GNUNET_CLIENT_TransmitHandle *GNUNET_CLIENT_notify_transmit_ready (struct
 156                                                                           GNUNET_CLIENT_Connection
 157                                                                           *sock,
 158                                                                           size_t
 159                                                                           size,
 160                                                                           struct
 161                                                                           GNUNET_TIME_Relative
 162                                                                           timeout,
 163                                                                           int
 164                                                                           auto_retry,
 165                                                                           GNUNET_CONNECTION_TransmitReadyNotify
 166                                                                           notify,
 167                                                                           void
 168                                                                           *notify_cls);
 169
 170
 171 /**
 172  * Cancel a request for notification.
 173  *
 174  * @param th handle from the original request.
 175  */
 176 void GNUNET_CLIENT_notify_transmit_ready_cancel (struct
 177                                                  GNUNET_CLIENT_TransmitHandle
 178                                                  *th);
 179
 180
 181 /**
 182  * Convenience API that combines sending a request
 183  * to the service and waiting for a response.
 184  * If either operation times out, the callback
 185  * will be called with a "NULL" response (in which
 186  * case the connection should probably be destroyed).
 187  *
 188  * @param sock connection to use
 189  * @param hdr message to transmit
 190  * @param timeout when to give up (for both transmission
 191  *         and for waiting for a response)
 192  * @param auto_retry if the connection to the service dies, should we
 193  *        automatically re-connect and retry (within the timeout period)
 194  *        or should we immediately fail in this case?  Pass GNUNET_YES
 195  *        if the caller does not care about temporary connection errors,
 196  *        for example because the protocol is stateless
 197  * @param rn function to call with the response
 198  * @param rn_cls closure for rn
 199  * @return GNUNET_OK on success, GNUNET_SYSERR if a request
 200  *         is already pending
 201  */
 202 int GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection
 203                                              *sock,
 204                                              const struct GNUNET_MessageHeader
 205                                              *hdr,
 206                                              struct GNUNET_TIME_Relative
 207                                              timeout, int auto_retry,
 208                                              GNUNET_CLIENT_MessageHandler rn,
 209                                              void *rn_cls);
 210
 211
 212 /**
 213  * Wait until the service is running.
 214  *
 215  * @param service name of the service to wait for
 216  * @param cfg configuration to use
 217  * @param timeout how long to wait at most in ms
 218  * @param task task to run if service is running
 219  *        (reason will be "PREREQ_DONE" (service running)
 220  *         or "TIMEOUT" (service not known to be running))
 221  * @param task_cls closure for task
 222  */
 223 void GNUNET_CLIENT_service_test (const char *service,
 224                                  const struct GNUNET_CONFIGURATION_Handle *cfg,
 225                                  struct GNUNET_TIME_Relative timeout,
 226                                  GNUNET_SCHEDULER_Task task, void *task_cls);
 227
 228
 229 #if 0                           /* keep Emacsens' auto-indent happy */
 230 {
 231 #endif
 232 #ifdef __cplusplus
 233 }
 234 #endif
 235
 236 /* ifndef GNUNET_CLIENT_LIB_H */
 237 #endif
 238 /* end of gnunet_client_lib.h */