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