src/util/server_tc.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 util/server_tc.c
  23  * @brief convenience functions for transmission of
  24  *        complex responses as a server
  25  * @author Christian Grothoff
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_common.h"
  30 #include "gnunet_connection_lib.h"
  31 #include "gnunet_scheduler_lib.h"
  32 #include "gnunet_server_lib.h"
  33 #include "gnunet_time_lib.h"
  34
  35
  36 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
  37
  38
  39 /**
  40  * How much buffer space do we want to have at least
  41  * before transmitting another increment?
  42  */
  43 #define MIN_BLOCK_SIZE 128
  44
  45
  46
  47 struct GNUNET_SERVER_TransmitContext
  48 {
  49   /**
  50    * Which client are we transmitting to?
  51    */
  52   struct GNUNET_SERVER_Client *client;
  53
  54   /**
  55    * Transmission buffer. (current offset for writing).
  56    */
  57   char *buf;
  58
  59   /**
  60    * Number of bytes in buf.
  61    */
  62   size_t total;
  63
  64   /**
  65    * Offset for writing in buf.
  66    */
  67   size_t off;
  68
  69   /**
  70    * Timeout for this request.
  71    */
  72   struct GNUNET_TIME_Absolute timeout;
  73 };
  74
  75
  76 /**
  77  * Helper function for incremental transmission of the response.
  78  */
  79 static size_t
  80 transmit_response (void *cls, size_t size, void *buf)
  81 {
  82   struct GNUNET_SERVER_TransmitContext *tc = cls;
  83   size_t msize;
  84
  85   if (NULL == buf)
  86   {
  87     GNUNET_SERVER_transmit_context_destroy (tc, GNUNET_SYSERR);
  88     return 0;
  89   }
  90   if (tc->total - tc->off > size)
  91     msize = size;
  92   else
  93     msize = tc->total - tc->off;
  94   memcpy (buf, &tc->buf[tc->off], msize);
  95   tc->off += msize;
  96   if (tc->total == tc->off)
  97   {
  98     GNUNET_SERVER_receive_done (tc->client, GNUNET_OK);
  99     GNUNET_SERVER_client_drop (tc->client);
 100     GNUNET_free_non_null (tc->buf);
 101     GNUNET_free (tc);
 102   }
 103   else
 104   {
 105     if (NULL ==
 106         GNUNET_SERVER_notify_transmit_ready (tc->client,
 107                                              GNUNET_MIN (MIN_BLOCK_SIZE,
 108                                                          tc->total - tc->off),
 109                                              GNUNET_TIME_absolute_get_remaining
 110                                              (tc->timeout), &transmit_response,
 111                                              tc))
 112     {
 113       GNUNET_break (0);
 114       GNUNET_SERVER_transmit_context_destroy (tc, GNUNET_SYSERR);
 115     }
 116   }
 117   return msize;
 118 }
 119
 120
 121 /**
 122  * Create a new transmission context for the
 123  * given client.
 124  *
 125  * @param client client to create the context for.
 126  * @return NULL on error
 127  */
 128 struct GNUNET_SERVER_TransmitContext *
 129 GNUNET_SERVER_transmit_context_create (struct GNUNET_SERVER_Client *client)
 130 {
 131   struct GNUNET_SERVER_TransmitContext *tc;
 132
 133   GNUNET_assert (NULL != client);
 134   tc = GNUNET_malloc (sizeof (struct GNUNET_SERVER_TransmitContext));
 135   GNUNET_SERVER_client_keep (client);
 136   tc->client = client;
 137   return tc;
 138 }
 139
 140
 141 /**
 142  * Append a message to the transmission context.
 143  * All messages in the context will be sent by
 144  * the transmit_context_run method.
 145  *
 146  * @param tc context to use
 147  * @param data what to append to the result message
 148  * @param length length of data
 149  * @param type type of the message
 150  */
 151 void
 152 GNUNET_SERVER_transmit_context_append_data (struct GNUNET_SERVER_TransmitContext
 153                                             *tc, const void *data,
 154                                             size_t length, uint16_t type)
 155 {
 156   struct GNUNET_MessageHeader *msg;
 157   size_t size;
 158
 159   GNUNET_assert (length < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 160   size = length + sizeof (struct GNUNET_MessageHeader);
 161   GNUNET_assert (size > length);
 162   tc->buf = GNUNET_realloc (tc->buf, tc->total + size);
 163   msg = (struct GNUNET_MessageHeader *) &tc->buf[tc->total];
 164   tc->total += size;
 165   msg->size = htons (size);
 166   msg->type = htons (type);
 167   memcpy (&msg[1], data, length);
 168 }
 169
 170
 171 /**
 172  * Append a message to the transmission context.
 173  * All messages in the context will be sent by
 174  * the transmit_context_run method.
 175  *
 176  * @param tc context to use
 177  * @param msg message to append
 178  */
 179 void
 180 GNUNET_SERVER_transmit_context_append_message (struct
 181                                                GNUNET_SERVER_TransmitContext
 182                                                *tc,
 183                                                const struct GNUNET_MessageHeader
 184                                                *msg)
 185 {
 186   struct GNUNET_MessageHeader *m;
 187   uint16_t size;
 188
 189   size = ntohs (msg->size);
 190   tc->buf = GNUNET_realloc (tc->buf, tc->total + size);
 191   m = (struct GNUNET_MessageHeader *) &tc->buf[tc->total];
 192   tc->total += size;
 193   memcpy (m, msg, size);
 194 }
 195
 196
 197 /**
 198  * Execute a transmission context.  If there is
 199  * an error in the transmission, the receive_done
 200  * method will be called with an error code (GNUNET_SYSERR),
 201  * otherwise with GNUNET_OK.
 202  *
 203  * @param tc transmission context to use
 204  * @param timeout when to time out and abort the transmission
 205  */
 206 void
 207 GNUNET_SERVER_transmit_context_run (struct GNUNET_SERVER_TransmitContext *tc,
 208                                     struct GNUNET_TIME_Relative timeout)
 209 {
 210   tc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 211   if (NULL ==
 212       GNUNET_SERVER_notify_transmit_ready (tc->client,
 213                                            GNUNET_MIN (MIN_BLOCK_SIZE,
 214                                                        tc->total), timeout,
 215                                            &transmit_response, tc))
 216   {
 217     GNUNET_break (0);
 218     GNUNET_SERVER_transmit_context_destroy (tc, GNUNET_SYSERR);
 219   }
 220 }
 221
 222
 223 /**
 224  * Destroy a transmission context. This function must not be called
 225  * after 'GNUNET_SERVER_transmit_context_run'.
 226  *
 227  * @param tc transmission context to destroy
 228  * @param success code to give to 'GNUNET_SERVER_receive_done' for
 229  *        the client:  GNUNET_OK to keep the connection open and
 230  *                          continue to receive
 231  *                GNUNET_NO to close the connection (normal behavior)
 232  *                GNUNET_SYSERR to close the connection (signal
 233  *                          serious error)
 234  */
 235 void
 236 GNUNET_SERVER_transmit_context_destroy (struct GNUNET_SERVER_TransmitContext
 237                                         *tc, int success)
 238 {
 239   GNUNET_SERVER_receive_done (tc->client, success);
 240   GNUNET_SERVER_client_drop (tc->client);
 241   GNUNET_free_non_null (tc->buf);
 242   GNUNET_free (tc);
 243 }
 244
 245
 246 /* end of server_tc.c */