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