aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_transport_plugin.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-12-11 22:50:10 +0000
committerChristian Grothoff <christian@grothoff.org>2013-12-11 22:50:10 +0000
commit9dbf3b587010260ad2e26450a86a37ecd298df11 (patch)
treeb475c461b0dd6906f885b9992a98e13cec5f36d2 /src/include/gnunet_transport_plugin.h
parent6f5773151141852cdb07a14edb2d5974d89814c2 (diff)
downloadgnunet-9dbf3b587010260ad2e26450a86a37ecd298df11.tar.gz
gnunet-9dbf3b587010260ad2e26450a86a37ecd298df11.zip
-more logging, etc.
Diffstat (limited to 'src/include/gnunet_transport_plugin.h')
-rw-r--r--src/include/gnunet_transport_plugin.h58
1 files changed, 29 insertions, 29 deletions
diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h
index f835bdcd8..7df04edfe 100644
--- a/src/include/gnunet_transport_plugin.h
+++ b/src/include/gnunet_transport_plugin.h
@@ -90,7 +90,7 @@ typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
90 * @param peer peer 90 * @param peer peer
91 * @param plugin plugin 91 * @param plugin plugin
92 * @param address address 92 * @param address address
93 * @param address_len length of the address 93 * @param address_len length of the @a address
94 * @param session session 94 * @param session session
95 * @param ats ATS information 95 * @param ats ATS information
96 * @param ats_count number of ATS information contained 96 * @param ats_count number of ATS information contained
@@ -122,7 +122,7 @@ typedef void
122 * for inbound TCP/UDP connections since it it not clear 122 * for inbound TCP/UDP connections since it it not clear
123 * that we could establish ourselves a connection to that 123 * that we could establish ourselves a connection to that
124 * IP address and get the same system) 124 * IP address and get the same system)
125 * @param sender_address_len number of bytes in sender_address 125 * @param sender_address_len number of bytes in @a sender_address
126 * @return how long the plugin should wait until receiving more data 126 * @return how long the plugin should wait until receiving more data
127 * (plugins that do not support this, can ignore the return value) 127 * (plugins that do not support this, can ignore the return value)
128 */ 128 */
@@ -141,7 +141,7 @@ typedef struct
141 * 141 *
142 * @param cls closure 142 * @param cls closure
143 * @param addr binary address 143 * @param addr binary address
144 * @param addrlen length of the address 144 * @param addrlen length of the @a addr
145 * @return ATS Information containing the network type 145 * @return ATS Information containing the network type
146 */ 146 */
147typedef struct GNUNET_ATS_Information 147typedef struct GNUNET_ATS_Information
@@ -156,10 +156,10 @@ typedef struct GNUNET_ATS_Information
156 * @param cls closure 156 * @param cls closure
157 * @param peer peer 157 * @param peer peer
158 * @param address address 158 * @param address address
159 * @param address_len length of the address 159 * @param address_len length of the @a address
160 * @param session session 160 * @param session session
161 * @param ats ATS information 161 * @param ats ATS information
162 * @param ats_count number of ATS information contained 162 * @param ats_count number of ATS information contained in @a ats
163 */ 163 */
164typedef void 164typedef void
165(*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls, 165(*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls,
@@ -183,7 +183,7 @@ typedef void
183 * @param dest_plugin plugin to use this address with 183 * @param dest_plugin plugin to use this address with
184 */ 184 */
185typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls, 185typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
186 int add_remove, 186 int add_remove,
187 const void *addr, 187 const void *addr,
188 size_t addrlen, 188 size_t addrlen,
189 const char *dest_plugin); 189 const char *dest_plugin);
@@ -312,19 +312,19 @@ struct GNUNET_TRANSPORT_PluginEnvironment
312 * 312 *
313 * @param cls closure 313 * @param cls closure
314 * @param target who was the recipient of the message? 314 * @param target who was the recipient of the message?
315 * @param result GNUNET_OK on success 315 * @param result #GNUNET_OK on success
316 * GNUNET_SYSERR if the target disconnected; 316 * #GNUNET_SYSERR if the target disconnected;
317 * disconnect will ALSO be signalled using 317 * disconnect will ALSO be signalled using
318 * the ReceiveCallback. 318 * the ReceiveCallback.
319 * @param size_payload bytes of payload from transport service in message 319 * @param size_payload bytes of payload from transport service in message
320 * @param size_on_wire bytes required on wire for transmission, 320 * @param size_on_wire bytes required on wire for transmission,
321 * 0 if result == GNUNET_SYSERR 321 * 0 if result == #GNUNET_SYSERR
322 */ 322 */
323typedef void (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls, 323typedef void (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
324 const struct GNUNET_PeerIdentity *target, 324 const struct GNUNET_PeerIdentity *target,
325 int result, 325 int result,
326 size_t size_payload, 326 size_t size_payload,
327 size_t size_on_wire); 327 size_t size_on_wire);
328 328
329/** 329/**
330 * The new send function with just the session and no address 330 * The new send function with just the session and no address
@@ -339,7 +339,7 @@ typedef void (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
339 * @param cls closure 339 * @param cls closure
340 * @param session which session must be used 340 * @param session which session must be used
341 * @param msgbuf the message to transmit 341 * @param msgbuf the message to transmit
342 * @param msgbuf_size number of bytes in 'msgbuf' 342 * @param msgbuf_size number of bytes in @a msgbuf
343 * @param priority how important is the message (most plugins will 343 * @param priority how important is the message (most plugins will
344 * ignore message priority and just FIFO) 344 * ignore message priority and just FIFO)
345 * @param to how long to wait at most for the transmission (does not 345 * @param to how long to wait at most for the transmission (does not
@@ -409,16 +409,16 @@ typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
409 * @param numeric should (IP) addresses be displayed in numeric form? 409 * @param numeric should (IP) addresses be displayed in numeric form?
410 * @param timeout after how long should we give up? 410 * @param timeout after how long should we give up?
411 * @param asc function to call on each string 411 * @param asc function to call on each string
412 * @param asc_cls closure for asc 412 * @param asc_cls closure for @a asc
413 */ 413 */
414typedef void (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls, 414typedef void (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
415 const char *type, 415 const char *type,
416 const void *addr, 416 const void *addr,
417 size_t addrlen, 417 size_t addrlen,
418 int numeric, 418 int numeric,
419 struct GNUNET_TIME_Relative timeout, 419 struct GNUNET_TIME_Relative timeout,
420 GNUNET_TRANSPORT_AddressStringCallback asc, 420 GNUNET_TRANSPORT_AddressStringCallback asc,
421 void *asc_cls); 421 void *asc_cls);
422 422
423 423
424/** 424/**
@@ -431,12 +431,12 @@ typedef void (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
431 * and not some potential man-in-the-middle). 431 * and not some potential man-in-the-middle).
432 * 432 *
433 * @param addr pointer to the address 433 * @param addr pointer to the address
434 * @param addrlen length of addr 434 * @param addrlen length of @a addr
435 * @return GNUNET_OK if this is a plausible address for this peer 435 * @return #GNUNET_OK if this is a plausible address for this peer
436 * and transport, GNUNET_SYSERR if not 436 * and transport, #GNUNET_SYSERR if not
437 */ 437 */
438typedef int (*GNUNET_TRANSPORT_CheckAddress) (void *cls, 438typedef int (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
439 const void *addr, 439 const void *addr,
440 size_t addrlen); 440 size_t addrlen);
441 441
442/** 442/**
@@ -473,11 +473,11 @@ typedef const char *(*GNUNET_TRANSPORT_AddressToString) (void *cls,
473 * 473 *
474 * @param cls closure ('struct Plugin*') 474 * @param cls closure ('struct Plugin*')
475 * @param addr string address 475 * @param addr string address
476 * @param addrlen length of the address including \0 termination 476 * @param addrlen length of the address including '\0' termination
477 * @param buf location to store the buffer 477 * @param buf location to store the buffer
478 * If the function returns GNUNET_SYSERR, its contents are undefined. 478 * If the function returns #GNUNET_SYSERR, its contents are undefined.
479 * @param added length of created address 479 * @param added length of created address
480 * @return GNUNET_OK on success, GNUNET_SYSERR on failure 480 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
481 */ 481 */
482typedef int (*GNUNET_TRANSPORT_StringToAddress) (void *cls, 482typedef int (*GNUNET_TRANSPORT_StringToAddress) (void *cls,
483 const char *addr, 483 const char *addr,