src/include/gnunet_client_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 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 3, 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  * @defgroup client Generic client-side communication with services
  26  * @{
  27  */
  28
  29 #ifndef GNUNET_CLIENT_LIB_H
  30 #define GNUNET_CLIENT_LIB_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40
  41 /**
  42  * Opaque handle for a connection to a service.
  43  */
  44 struct GNUNET_CLIENT_Connection;
  45
  46 /**
  47  * Get a connection with a service.
  48  *
  49  * @param service_name name of the service
  50  * @param cfg configuration to use
  51  * @return NULL on error (service unknown to configuration)
  52  */
  53 struct GNUNET_CLIENT_Connection *
  54 GNUNET_CLIENT_connect (const char *service_name,
  55                        const struct GNUNET_CONFIGURATION_Handle *cfg);
  56
  57
  58 /**
  59  * Destroy connection with the service.  This will automatically
  60  * cancel any pending "receive" request (however, the handler will
  61  * *NOT* be called, not even with a NULL message).  Any pending
  62  * transmission request will also be cancelled UNLESS the callback for
  63  * the transmission request has already been called, in which case the
  64  * transmission 'finish_pending_write' argument determines whether or
  65  * not the write is guaranteed to complete before the socket is fully
  66  * destroyed (unless, of course, there is an error with the server in
  67  * which case the message may still be lost).
  68  *
  69  * @param client handle to the service connection
  70  */
  71 void
  72 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *client);
  73
  74
  75 /**
  76  * Type of a function to call when we receive a message
  77  * from the service.
  78  *
  79  * @param cls closure
  80  * @param msg message received, NULL on timeout or fatal error
  81  */
  82 typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
  83                                               const struct GNUNET_MessageHeader *msg);
  84
  85
  86 /**
  87  * Read from the service.
  88  *
  89  * @param client connection to the service
  90  * @param handler function to call with the message
  91  * @param handler_cls closure for @a handler
  92  * @param timeout how long to wait until timing out
  93  */
  94 void
  95 GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *client,
  96                        GNUNET_CLIENT_MessageHandler handler, void *handler_cls,
  97                        struct GNUNET_TIME_Relative timeout);
  98
  99
 100 /**
 101  * Transmit handle for client connections.
 102  */
 103 struct GNUNET_CLIENT_TransmitHandle;
 104
 105
 106 /**
 107  * Ask the client to call us once the specified number of bytes
 108  * are free in the transmission buffer.  May call the notify
 109  * method immediately if enough space is available.
 110  *
 111  * @param client connection to the service
 112  * @param size number of bytes to send
 113  * @param timeout after how long should we give up (and call
 114  *        @a notify with buf NULL and size 0)?
 115  * @param auto_retry if the connection to the service dies, should we
 116  *        automatically re-connect and retry (within the timeout period)
 117  *        or should we immediately fail in this case?  Pass #GNUNET_YES
 118  *        if the caller does not care about temporary connection errors,
 119  *        for example because the protocol is stateless
 120  * @param notify function to call
 121  * @param notify_cls closure for @a notify
 122  * @return NULL if someone else is already waiting to be notified
 123  *         non-NULL if the notify callback was queued (can be used to cancel
 124  *         using #GNUNET_CONNECTION_notify_transmit_ready_cancel)
 125  */
 126 struct GNUNET_CLIENT_TransmitHandle *
 127 GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *client,
 128                                      size_t size,
 129                                      struct GNUNET_TIME_Relative timeout,
 130                                      int auto_retry,
 131                                      GNUNET_CONNECTION_TransmitReadyNotify notify,
 132                                      void *notify_cls);
 133
 134
 135 /**
 136  * Cancel a request for notification.
 137  *
 138  * @param th handle from the original request.
 139  */
 140 void
 141 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle
 142                                             *th);
 143
 144
 145 /**
 146  * Convenience API that combines sending a request
 147  * to the service and waiting for a response.
 148  * If either operation times out, the callback
 149  * will be called with a "NULL" response (in which
 150  * case the connection should probably be destroyed).
 151  *
 152  * @param client connection to use
 153  * @param hdr message to transmit
 154  * @param timeout when to give up (for both transmission
 155  *         and for waiting for a response)
 156  * @param auto_retry if the connection to the service dies, should we
 157  *        automatically re-connect and retry (within the timeout period)
 158  *        or should we immediately fail in this case?  Pass #GNUNET_YES
 159  *        if the caller does not care about temporary connection errors,
 160  *        for example because the protocol is stateless
 161  * @param rn function to call with the response
 162  * @param rn_cls closure for @a rn
 163  * @return #GNUNET_OK on success, #GNUNET_SYSERR if a request
 164  *         is already pending
 165  */
 166 int
 167 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *client,
 168                                          const struct GNUNET_MessageHeader *hdr,
 169                                          struct GNUNET_TIME_Relative timeout,
 170                                          int auto_retry,
 171                                          GNUNET_CLIENT_MessageHandler rn,
 172                                          void *rn_cls);
 173
 174
 175 /**
 176  * Handle for a test to check if a service is running.
 177  */
 178 struct GNUNET_CLIENT_TestHandle;
 179
 180 /**
 181  * Function called with the result on the service test.
 182  *
 183  * @param cls closure
 184  * @param result #GNUNET_YES if the service is running,
 185  *               #GNUNET_NO if the service is not running
 186  *               #GNUNET_SYSERR if the configuration is invalid
 187  */
 188 typedef void (*GNUNET_CLIENT_TestResultCallback)(void *cls,
 189                                                  int result);
 190
 191
 192 /**
 193  * Test if the service is running.  If we are given a UNIXPATH or a
 194  * local address, we do this NOT by trying to connect to the service,
 195  * but by trying to BIND to the same port.  If the BIND fails, we know
 196  * the service is running.
 197  *
 198  * @param service name of the service to wait for
 199  * @param cfg configuration to use
 200  * @param timeout how long to wait at most
 201  * @param cb function to call with the result
 202  * @param cb_cls closure for @a cb
 203  * @return handle to cancel the test
 204  */
 205 struct GNUNET_CLIENT_TestHandle *
 206 GNUNET_CLIENT_service_test (const char *service,
 207                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 208                             struct GNUNET_TIME_Relative timeout,
 209                             GNUNET_CLIENT_TestResultCallback cb, void *cb_cls);
 210
 211
 212 /**
 213  * Abort testing for service.
 214  *
 215  * @param th test handle
 216  */
 217 void
 218 GNUNET_CLIENT_service_test_cancel (struct GNUNET_CLIENT_TestHandle *th);
 219
 220
 221 #if 0                           /* keep Emacsens' auto-indent happy */
 222 {
 223 #endif
 224 #ifdef __cplusplus
 225 }
 226 #endif
 227
 228 /** @} */ /* end of group client */
 229
 230 /* ifndef GNUNET_CLIENT_LIB_H */
 231 #endif
 232 /* end of gnunet_client_lib.h */