src/include/gnunet_psyc_util_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012, 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_psyc_service.h
  23  * @brief PSYC utilities; receiving/transmitting/logging PSYC messages.
  24  * @author Gabor X Toth
  25  */
  26
  27 #ifndef GNUNET_PSYC_UTIL_LIB_H
  28 #define GNUNET_PSYC_UTIL_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_util_lib.h"
  39 #include "gnunet_env_lib.h"
  40 #include "gnunet_psyc_service.h"
  41
  42
  43 /**
  44  * Create a PSYC message.
  45  *
  46  * @param method_name
  47  *        PSYC method for the message.
  48  * @param env
  49  *        Environment for the message.
  50  * @param data
  51  *        Data payload for the message.
  52  * @param data_size
  53  *        Size of @a data.
  54  *
  55  * @return Message header with size information,
  56  *         followed by the message parts.
  57  */
  58 struct GNUNET_PSYC_Message *
  59 GNUNET_PSYC_message_create (const char *method_name,
  60                             const struct GNUNET_ENV_Environment *env,
  61                             const void *data,
  62                             size_t data_size);
  63
  64 /**
  65  * Parse PSYC message.
  66  *
  67  * @param msg
  68  *        The PSYC message to parse.
  69  * @param env
  70  *        The environment for the message with a list of modifiers.
  71  * @param[out] method_name
  72  *        Pointer to the method name inside @a pmsg.
  73  * @param[out] data
  74  *        Pointer to data inside @a pmsg.
  75  * @param[out] data_size
  76  *        Size of @data is written here.
  77  *
  78  * @return #GNUNET_OK on success,
  79  *         #GNUNET_SYSERR on parse error.
  80  */
  81 int
  82 GNUNET_PSYC_message_parse (const struct GNUNET_PSYC_Message *msg,
  83                            const char **method_name,
  84                            struct GNUNET_ENV_Environment *env,
  85                            const void **data,
  86                            uint16_t *data_size);
  87
  88
  89 void
  90 GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
  91                          const struct GNUNET_MessageHeader *msg);
  92
  93
  94 int
  95 GNUNET_PSYC_check_message_parts (uint16_t data_size, const char *data,
  96                                  uint16_t *first_ptype, uint16_t *last_ptype);
  97
  98
  99 struct GNUNET_PSYC_TransmitHandle;
 100
 101 /**
 102  * Create a transmission handle.
 103  */
 104 struct GNUNET_PSYC_TransmitHandle *
 105 GNUNET_PSYC_transmit_create ();
 106
 107
 108 /**
 109  * Destroy a transmission handle.
 110  */
 111 void
 112 GNUNET_PSYC_transmit_destroy (struct GNUNET_PSYC_TransmitHandle *tmit);
 113
 114
 115 /**
 116  * Transmit a message.
 117  *
 118  * @param tmit         Transmission handle.
 119  * @param method_name  Which method should be invoked.
 120  * @param env          Environment for the message.
 121  *   Should stay available until the first call to notify_data.
 122  *   Can be NULL if there are no modifiers or @a notify_mod is provided instead.
 123  * @param notify_mod   Function to call to obtain modifiers.
 124  *   Can be NULL if there are no modifiers or @a env is provided instead.
 125  * @param notify_data  Function to call to obtain fragments of the data.
 126  * @param notify_cls   Closure for @a notify_mod and @a notify_data.
 127  * @param flags        Flags for the message being transmitted.
 128  *
 129  * @return #GNUNET_OK if the transmission was started.
 130  *         #GNUNET_SYSERR if another transmission is already going on.
 131  */
 132 int
 133 GNUNET_PSYC_transmit_message (struct GNUNET_PSYC_TransmitHandle *tmit,
 134                               const char *method_name,
 135                               const struct GNUNET_ENV_Environment *env,
 136                               GNUNET_PSYC_TransmitNotifyModifier notify_mod,
 137                               GNUNET_PSYC_TransmitNotifyData notify_data,
 138                               void *notify_cls,
 139                               uint32_t flags);
 140
 141
 142 /**
 143  * Resume transmission.
 144  *
 145  * @param tmit  Transmission handle.
 146  */
 147 void
 148 GNUNET_PSYC_transmit_resume (struct GNUNET_PSYC_TransmitHandle *tmit);
 149
 150
 151 /**
 152  * Abort transmission request.
 153  *
 154  * @param tmit  Transmission handle.
 155  */
 156 void
 157 GNUNET_PSYC_transmit_cancel (struct GNUNET_PSYC_TransmitHandle *tmit);
 158
 159
 160 /**
 161  * Got acknowledgement of a transmitted message part, continue transmission.
 162  *
 163  * @param tmit  Transmission handle.
 164  */
 165 void
 166 GNUNET_PSYC_transmit_got_ack (struct GNUNET_PSYC_TransmitHandle *tmit);
 167
 168
 169 struct GNUNET_PSYC_ReceiveHandle;
 170
 171
 172 /**
 173  * Create handle for receiving messages.
 174  */
 175 struct GNUNET_PSYC_ReceiveHandle *
 176 GNUNET_PSYC_receive_create (GNUNET_PSYC_MessageCallback message_cb,
 177                             GNUNET_PSYC_MessagePartCallback message_part_cb,
 178                             void *cb_cls);
 179
 180
 181 /**
 182  * Destroy handle for receiving messages.
 183  */
 184 void
 185 GNUNET_PSYC_receive_destroy (struct GNUNET_PSYC_ReceiveHandle *recv);
 186
 187
 188 /**
 189  * Reset stored data related to the last received message.
 190  */
 191 void
 192 GNUNET_PSYC_receive_reset (struct GNUNET_PSYC_ReceiveHandle *recv);
 193
 194
 195 /**
 196  * Handle incoming PSYC message.
 197  *
 198  * @param recv  Receive handle.
 199  * @param msg   The message.
 200  *
 201  * @return #GNUNET_OK on success,
 202  *         #GNUNET_SYSERR on receive error.
 203  */
 204 int
 205 GNUNET_PSYC_receive_message (struct GNUNET_PSYC_ReceiveHandle *recv,
 206                              const struct GNUNET_PSYC_MessageHeader *msg);
 207
 208
 209 /**
 210  * Check if @a data contains a series of valid message parts.
 211  *
 212  * @param      data_size    Size of @a data.
 213  * @param      data         Data.
 214  * @param[out] first_ptype  Type of first message part.
 215  * @param[out] last_ptype   Type of last message part.
 216  *
 217  * @return Number of message parts found in @a data.
 218  *         or GNUNET_SYSERR if the message contains invalid parts.
 219  */
 220 int
 221 GNUNET_PSYC_receive_check_parts (uint16_t data_size, const char *data,
 222                                  uint16_t *first_ptype, uint16_t *last_ptype);
 223
 224
 225 #if 0                           /* keep Emacsens' auto-indent happy */
 226 {
 227 #endif
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 /* ifndef GNUNET_PSYC_UTIL_LIB_H */
 233 #endif
 234 /* end of gnunet_psyc_util_lib.h */