aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_mq_lib.h
diff options
context:
space:
mode:
authorGabor X Toth <*@tg-x.net>2016-09-23 21:17:13 +0000
committerGabor X Toth <*@tg-x.net>2016-09-23 21:17:13 +0000
commitf5e65b30356f20c7fd6f80fc1a9cb6de8e035505 (patch)
treeeb92f01bd857e721d483f4dc1e938151f6569950 /src/include/gnunet_mq_lib.h
parent451fd32170103921993d876d765a8755ce737a0b (diff)
downloadgnunet-f5e65b30356f20c7fd6f80fc1a9cb6de8e035505.tar.gz
gnunet-f5e65b30356f20c7fd6f80fc1a9cb6de8e035505.zip
MQ doc
Diffstat (limited to 'src/include/gnunet_mq_lib.h')
-rw-r--r--src/include/gnunet_mq_lib.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h
index 567624985..08434698e 100644
--- a/src/include/gnunet_mq_lib.h
+++ b/src/include/gnunet_mq_lib.h
@@ -42,7 +42,8 @@
42 * The allocated message will already have the type and size field set. 42 * The allocated message will already have the type and size field set.
43 * 43 *
44 * @param mvar variable to store the allocated message in; 44 * @param mvar variable to store the allocated message in;
45 * must have a header field 45 * must have a header field;
46 * can be NULL
46 * @param esize extra space to allocate after the message 47 * @param esize extra space to allocate after the message
47 * @param type type of the message 48 * @param type type of the message
48 * @return the MQ message 49 * @return the MQ message
@@ -54,7 +55,8 @@
54 * The contained message will already have the type and size field set. 55 * The contained message will already have the type and size field set.
55 * 56 *
56 * @param mvar variable to store the allocated message in; 57 * @param mvar variable to store the allocated message in;
57 * must have a header field 58 * must have a header field;
59 * can be NULL
58 * @param type type of the message 60 * @param type type of the message
59 * @return the allocated envelope 61 * @return the allocated envelope
60 */ 62 */
@@ -111,6 +113,7 @@
111 * @param mh message header to extract nested message header from 113 * @param mh message header to extract nested message header from
112 * @param base_size size of the message before the nested message's header appears 114 * @param base_size size of the message before the nested message's header appears
113 * @return pointer to the nested message, does not copy the message 115 * @return pointer to the nested message, does not copy the message
116 * OR NULL in case of a malformed message.
114 */ 117 */
115const struct GNUNET_MessageHeader * 118const struct GNUNET_MessageHeader *
116GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh, 119GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh,