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 sched scheduler to use
  53  * @param service_name name of the service
  54  * @param cfg configuration to use
  55  * @return NULL on error (service unknown to configuration)
  56  */
  57 struct GNUNET_CLIENT_Connection *GNUNET_CLIENT_connect (struct
  58                                                         GNUNET_SCHEDULER_Handle
  59                                                         *sched,
  60                                                         const char
  61                                                         *service_name,
  62                                                         const struct
  63                                                         GNUNET_CONFIGURATION_Handle
  64                                                         *cfg);
  65
  66
  67 /**
  68  * Configure this connection to ignore shutdown signals.
  69  *
  70  * @param h client handle
  71  * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
  72  */
  73 void
  74 GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
  75                                int do_ignore);
  76
  77
  78
  79 /**
  80  * Destroy connection with the service.  This will automatically
  81  * cancel any pending "receive" request (however, the handler will
  82  * *NOT* be called, not even with a NULL message).  Any pending
  83  * transmission request will also be cancelled UNLESS the callback for
  84  * the transmission request has already been called, in which case the
  85  * transmission 'finish_pending_write' argument determines whether or
  86  * not the write is guaranteed to complete before the socket is fully
  87  * destroyed (unless, of course, there is an error with the server in
  88  * which case the message may still be lost).
  89  *
  90  * @param sock handle to the service connection
  91  * @param finish_pending_write should a transmission already passed to the
  92  *          handle be completed?
  93  */
  94 void GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
  95                                int finish_pending_write);
  96
  97 /**
  98  * Type of a function to call when we receive a message
  99  * from the service.
 100  *
 101  * @param cls closure
 102  * @param msg message received, NULL on timeout or fatal error
 103  */
 104 typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
 105                                               const struct
 106                                               GNUNET_MessageHeader * msg);
 107
 108 /**
 109  * Type of a function to call when we have finished shutting
 110  * down a service, or failed.
 111  *
 112  * @param cls closure
 113  * @param reason what is the result of the shutdown
 114  *        GNUNET_NO on shutdown (not running)
 115  *        GNUNET_YES on running
 116  *        GNUNET_SYSERR on failure to transmit message
 117  */
 118 typedef void (*GNUNET_CLIENT_ShutdownTask) (void *cls,
 119                                             int reason);
 120
 121 /**
 122  * Read from the service.
 123  *
 124  * @param sock the service
 125  * @param handler function to call with the message
 126  * @param handler_cls closure for handler
 127  * @param timeout how long to wait until timing out
 128  */
 129 void GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *sock,
 130                             GNUNET_CLIENT_MessageHandler handler,
 131                             void *handler_cls,
 132                             struct GNUNET_TIME_Relative timeout);
 133
 134
 135 /**
 136  * Transmit handle for client connections.
 137  */
 138 struct GNUNET_CLIENT_TransmitHandle;
 139
 140
 141 /**
 142  * Ask the client to call us once the specified number of bytes
 143  * are free in the transmission buffer.  May call the notify
 144  * method immediately if enough space is available.
 145  *
 146  * @param sock connection to the service
 147  * @param size number of bytes to send
 148  * @param timeout after how long should we give up (and call
 149  *        notify with buf NULL and size 0)?
 150  * @param auto_retry if the connection to the service dies, should we
 151  *        automatically re-connect and retry (within the timeout period)
 152  *        or should we immediately fail in this case?  Pass GNUNET_YES
 153  *        if the caller does not care about temporary connection errors,
 154  *        for example because the protocol is stateless
 155  * @param notify function to call
 156  * @param notify_cls closure for notify
 157  * @return NULL if someone else is already waiting to be notified
 158  *         non-NULL if the notify callback was queued (can be used to cancel
 159  *         using GNUNET_CONNECTION_notify_transmit_ready_cancel)
 160  */
 161 struct GNUNET_CLIENT_TransmitHandle
 162   *GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *sock,
 163                                         size_t size,
 164                                         struct GNUNET_TIME_Relative timeout,
 165                                         int auto_retry,
 166                                         GNUNET_CONNECTION_TransmitReadyNotify
 167                                         notify,
 168                                         void *notify_cls);
 169
 170
 171 /**
 172  * Cancel a request for notification.
 173  *
 174  * @param th handle from the original request.
 175  */
 176 void
 177 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle *th);
 178
 179
 180 /**
 181  * Convenience API that combines sending a request
 182  * to the service and waiting for a response.
 183  * If either operation times out, the callback
 184  * will be called with a "NULL" response (in which
 185  * case the connection should probably be destroyed).
 186  *
 187  * @param sock connection to use
 188  * @param hdr message to transmit
 189  * @param timeout when to give up (for both transmission
 190  *         and for waiting for a response)
 191  * @param auto_retry if the connection to the service dies, should we
 192  *        automatically re-connect and retry (within the timeout period)
 193  *        or should we immediately fail in this case?  Pass GNUNET_YES
 194  *        if the caller does not care about temporary connection errors,
 195  *        for example because the protocol is stateless
 196  * @param rn function to call with the response
 197  * @param rn_cls closure for rn
 198  * @return GNUNET_OK on success, GNUNET_SYSERR if a request
 199  *         is already pending
 200  */
 201 int
 202 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *sock,
 203                                          const struct GNUNET_MessageHeader *hdr,
 204                                          struct GNUNET_TIME_Relative timeout,
 205                                          int auto_retry,
 206                                          GNUNET_CLIENT_MessageHandler rn,
 207                                          void *rn_cls);
 208
 209
 210 /**
 211  * Wait until the service is running.
 212  *
 213  * @param sched scheduler to use
 214  * @param service name of the service to wait for
 215  * @param cfg configuration to use
 216  * @param timeout how long to wait at most in ms
 217  * @param task task to run if service is running
 218  *        (reason will be "PREREQ_DONE" (service running)
 219  *         or "TIMEOUT" (service not known to be running))
 220  * @param task_cls closure for task
 221  */
 222 void GNUNET_CLIENT_service_test (struct GNUNET_SCHEDULER_Handle *sched,
 223                                  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 */