2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_psyc_service.h
23 * @brief PSYC utilities; receiving/transmitting/logging PSYC messages.
24 * @author Gabor X Toth
27 #ifndef GNUNET_PSYC_UTIL_LIB_H
28 #define GNUNET_PSYC_UTIL_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_env_lib.h"
40 #include "gnunet_psyc_service.h"
44 * Create a PSYC message.
47 * PSYC method for the message.
49 * Environment for the message.
51 * Data payload for the message.
55 * @return Message header with size information,
56 * followed by the message parts.
58 struct GNUNET_PSYC_Message *
59 GNUNET_PSYC_message_create (const char *method_name,
60 const struct GNUNET_ENV_Environment *env,
68 * The PSYC message to parse.
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.
74 * Pointer to data inside @a pmsg.
75 * @param[out] data_size
76 * Size of @data is written here.
78 * @return #GNUNET_OK on success,
79 * #GNUNET_SYSERR on parse error.
82 GNUNET_PSYC_message_parse (const struct GNUNET_PSYC_Message *msg,
83 const char **method_name,
84 struct GNUNET_ENV_Environment *env,
90 GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
91 const struct GNUNET_MessageHeader *msg);
95 GNUNET_PSYC_check_message_parts (uint16_t data_size, const char *data,
96 uint16_t *first_ptype, uint16_t *last_ptype);
99 struct GNUNET_PSYC_TransmitHandle;
102 * Create a transmission handle.
104 struct GNUNET_PSYC_TransmitHandle *
105 GNUNET_PSYC_transmit_create ();
109 * Destroy a transmission handle.
112 GNUNET_PSYC_transmit_destroy (struct GNUNET_PSYC_TransmitHandle *tmit);
116 * Transmit a message.
119 * Transmission handle.
121 * Which method should be invoked.
123 * Environment for the message.
124 * Should stay available until the first call to notify_data.
125 * Can be NULL if there are no modifiers or @a notify_mod is
128 * Function to call to obtain modifiers.
129 * Can be NULL if there are no modifiers or @a env is provided instead.
131 * Function to call to obtain fragments of the data.
133 * Closure for @a notify_mod and @a notify_data.
135 * Flags for the message being transmitted.
137 * @return #GNUNET_OK if the transmission was started.
138 * #GNUNET_SYSERR if another transmission is already going on.
141 GNUNET_PSYC_transmit_message (struct GNUNET_PSYC_TransmitHandle *tmit,
142 const char *method_name,
143 const struct GNUNET_ENV_Environment *env,
144 GNUNET_PSYC_TransmitNotifyModifier notify_mod,
145 GNUNET_PSYC_TransmitNotifyData notify_data,
151 * Resume transmission.
153 * @param tmit Transmission handle.
156 GNUNET_PSYC_transmit_resume (struct GNUNET_PSYC_TransmitHandle *tmit);
160 * Abort transmission request.
162 * @param tmit Transmission handle.
165 GNUNET_PSYC_transmit_cancel (struct GNUNET_PSYC_TransmitHandle *tmit);
169 * Got acknowledgement of a transmitted message part, continue transmission.
171 * @param tmit Transmission handle.
174 GNUNET_PSYC_transmit_got_ack (struct GNUNET_PSYC_TransmitHandle *tmit);
177 struct GNUNET_PSYC_ReceiveHandle;
181 * Create handle for receiving messages.
183 struct GNUNET_PSYC_ReceiveHandle *
184 GNUNET_PSYC_receive_create (GNUNET_PSYC_MessageCallback message_cb,
185 GNUNET_PSYC_MessagePartCallback message_part_cb,
190 * Destroy handle for receiving messages.
193 GNUNET_PSYC_receive_destroy (struct GNUNET_PSYC_ReceiveHandle *recv);
197 * Reset stored data related to the last received message.
200 GNUNET_PSYC_receive_reset (struct GNUNET_PSYC_ReceiveHandle *recv);
204 * Handle incoming PSYC message.
206 * @param recv Receive handle.
207 * @param msg The message.
209 * @return #GNUNET_OK on success,
210 * #GNUNET_SYSERR on receive error.
213 GNUNET_PSYC_receive_message (struct GNUNET_PSYC_ReceiveHandle *recv,
214 const struct GNUNET_PSYC_MessageHeader *msg);
218 * Check if @a data contains a series of valid message parts.
220 * @param data_size Size of @a data.
222 * @param[out] first_ptype Type of first message part.
223 * @param[out] last_ptype Type of last message part.
225 * @return Number of message parts found in @a data.
226 * or GNUNET_SYSERR if the message contains invalid parts.
229 GNUNET_PSYC_receive_check_parts (uint16_t data_size, const char *data,
230 uint16_t *first_ptype, uint16_t *last_ptype);
233 #if 0 /* keep Emacsens' auto-indent happy */
240 /* ifndef GNUNET_PSYC_UTIL_LIB_H */
242 /* end of gnunet_psyc_util_lib.h */