diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-10-02 20:49:01 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-10-02 20:49:01 +0000 |
commit | 0452911c66bfbd8852eea27d90108be97aa84982 (patch) | |
tree | 9f59ff4a397754b5598a08917381b28cf6fe291f /src/include/gnunet_helper_lib.h | |
parent | 6a34f8a03004e15e28e7ac11261ab9585e223b75 (diff) | |
download | gnunet-0452911c66bfbd8852eea27d90108be97aa84982.tar.gz gnunet-0452911c66bfbd8852eea27d90108be97aa84982.zip |
-docu helper api better
Diffstat (limited to 'src/include/gnunet_helper_lib.h')
-rw-r--r-- | src/include/gnunet_helper_lib.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/include/gnunet_helper_lib.h b/src/include/gnunet_helper_lib.h index 281ee9ba6..fde0a69ed 100644 --- a/src/include/gnunet_helper_lib.h +++ b/src/include/gnunet_helper_lib.h | |||
@@ -124,7 +124,7 @@ GNUNET_HELPER_stop (struct GNUNET_HELPER_Handle *h, int soft_kill); | |||
124 | * @param cls closure | 124 | * @param cls closure |
125 | * @param result #GNUNET_OK on success, | 125 | * @param result #GNUNET_OK on success, |
126 | * #GNUNET_NO if helper process died | 126 | * #GNUNET_NO if helper process died |
127 | * #GNUNET_SYSERR during GNUNET_HELPER_stop | 127 | * #GNUNET_SYSERR during GNUNET_HELPER_destroy |
128 | */ | 128 | */ |
129 | typedef void (*GNUNET_HELPER_Continuation)(void *cls, | 129 | typedef void (*GNUNET_HELPER_Continuation)(void *cls, |
130 | int result); | 130 | int result); |
@@ -142,10 +142,11 @@ struct GNUNET_HELPER_SendHandle; | |||
142 | * @param h helper to send message to | 142 | * @param h helper to send message to |
143 | * @param msg message to send | 143 | * @param msg message to send |
144 | * @param can_drop can the message be dropped if there is already one in the queue? | 144 | * @param can_drop can the message be dropped if there is already one in the queue? |
145 | * @param cont continuation to run once the message is out | 145 | * @param cont continuation to run once the message is out (#GNUNET_OK on succees, #GNUNET_NO |
146 | * if the helper process died, #GNUNET_SYSERR during #GNUNET_HELPER_destroy). | ||
146 | * @param cont_cls closure for @a cont | 147 | * @param cont_cls closure for @a cont |
147 | * @return NULL if the message was dropped, | 148 | * @return NULL if the message was dropped, |
148 | * otherwise handle to cancel *cont* (actual transmission may | 149 | * otherwise handle to cancel @a cont (actual transmission may |
149 | * not be abortable) | 150 | * not be abortable) |
150 | */ | 151 | */ |
151 | struct GNUNET_HELPER_SendHandle * | 152 | struct GNUNET_HELPER_SendHandle * |