*/
/**
- * @file dns/dns_api_new.c
+ * @file dns/dns_api.c
* @brief API to access the DNS service.
* @author Christian Grothoff
*/
/**
- * Output the given DNS query to stdout.
+ * Output the given DNS record to stdout.
*
- * @param query query to display.
+ * @param record record to display.
*/
static void
display_record (const struct GNUNET_DNSPARSER_Record *record)
/**
- * Output the given DNS query to stdout.
+ * Modify the given DNS record.
*
- * @param query query to display.
+ * @param record record to modify
*/
static void
modify_record (const struct GNUNET_DNSPARSER_Record *record)
* @param cls closure
* @param tunnel new handle to the tunnel
* @param initiator peer that started the tunnel
- * @param atsi performance information for the tunnel
+ * @param ats performance information for the tunnel
* @return initial tunnel context for the tunnel
*/
static void *
*/
/**
- * @file vpn/plugin_block_dns.c
+ * @file dns/plugin_block_dns.c
* @brief block plugin for storing .gnunet-bindings
* @author Philipp Tölke
*/
* TCP header, depending on protocol)
* @param payload_length number of bytes in 'payload'
* @param protocol IPPROTO_UDP or IPPROTO_TCP
+ * @param tcp_header skeleton of the TCP header, NULL for UDP
* @param src_address source address to use (IP and port)
* @param dst_address destination address to use (IP and port)
* @param pkt6 where to write the assembled packet; must
*
* @param destination_address IP and port to use for the TCP packet's destination
* @param source_address IP and port to use for the TCP packet's source
- * @param tcp header template to use
+ * @param tcp_header header template to use
* @param payload payload of the TCP packet
* @param payload_length number of bytes in 'payload'
*/
* GNUNET_SYSERR to close it (signal serious error)
*/
static int
-receive_tcp_service (void *unused GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
+receive_tcp_service (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
void **tunnel_ctx GNUNET_UNUSED,
const struct GNUNET_PeerIdentity *sender GNUNET_UNUSED,
const struct GNUNET_MessageHeader *message,
/**
* Write progress message.
* Format is:
- * <reason><filename length><filename><directory flag>
+ * "reason", "filename length", "filename", "directory flag"
* If filename is NULL, filename is not written, and its length
* is written as 0, and nothing else is written. It signals the initiator
* thread that the scanner is finished, and that it can now join its thread.
/**
* Extract metadata from a file and add it to the share tree
*
- * @param adc context to modify
+ * @param ads context to modify
* @param filename name of the file to process
*/
static void
* @param pr handle to the original pending request
* @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
* @param expiration when does 'data' expire?
+ * @param last_transmission when did we last transmit a request for this block
* @param type type of the block
* @param data response data, NULL on request expiration
* @param data_len number of bytes in data
/**
* Get the last transmission attempt time for the request plan list
- * referenced by @rpr_head, that was sent to @sender
+ * referenced by 'rpr_head', that was sent to 'sender'
*
* @param rpr_head request plan reference list to check.
* @param sender the peer that we've sent the request to.
* @param result the timestamp to fill.
- * @return GNUNET_YES if @result was changed, GNUNET_NO otherwise.
+ * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
*/
int
GSF_request_plan_reference_get_last_transmission_ (
/**
* Get the last transmission attempt time for the request plan list
- * referenced by @rpr_head, that was sent to @sender
+ * referenced by 'rpr_head', that was sent to 'sender'
*
* @param rpr_head request plan reference list to check.
* @param sender the peer that we've sent the request to.
* @param result the timestamp to fill.
- * @return GNUNET_YES if @result was changed, GNUNET_NO otherwise.
+ * @return GNUNET_YES if 'result' was changed, GNUNET_NO otherwise.
*/
int
GSF_request_plan_reference_get_last_transmission_ (
* @return the same value in host byte order
*/
double
-GNUNET_hton_double (double in);
+GNUNET_hton_double (double d);
/**
* Convert double to host-byte-order
* @return the same value in host byte order
*/
double
-GNUNET_ntoh_double (double in);
+GNUNET_ntoh_double (double d);
/* ************************* allocation functions ****************** */
/**
* Creates an interprocess channel
- * @param blocking creates an asynchronous pipe if set to GNUNET_NO
+ *
+ * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
+ * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
* @param inherit_read 1 to make read handle inheritable, 0 otherwise (NT only)
* @param inherit_write 1 to make write handle inheritable, 0 otherwise (NT only)
* @return handle to the new pipe, NULL on error
*/
/**
- * @file include/gnunet_dns_service-new.h
+ * @file include/gnunet_dns_service.h
* @brief API to access the DNS service.
* @author Christian Grothoff
*/
*/
/**
- * @file include/gnunet_dnsparse_lib.h
+ * @file include/gnunet_dnsparser_lib.h
* @brief API for helper library to parse DNS packets.
* @author Philipp Toelke
* @author Christian Grothoff
/**
* Calculate IPv4 TCP checksum.
*
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
* @param tcp TCP header (initialized except for CRC)
* @param payload the TCP payload
* @param payload_length number of bytes of TCP payload
/**
* Calculate IPv6 TCP checksum.
*
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
* @param tcp TCP header (initialized except for CRC)
* @param payload the TCP payload
* @param payload_length number of bytes of TCP payload
/**
* Calculate IPv4 UDP checksum.
*
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
* @param udp UDP header (initialized except for CRC)
* @param payload the UDP payload
* @param payload_length number of bytes of UDP payload
/**
* Calculate IPv6 UDP checksum.
*
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
* @param udp UDP header (initialized except for CRC)
* @param payload the UDP payload
* @param payload_length number of bytes of UDP payload
*/
/**
- * @file template/gnunet-testing.c
+ * @file testing/gnunet-testing.c
* @brief tool to use testing functionality from cmd line
* @author Christian Grothoff
*/
/**
* Calculate IPv4 TCP checksum.
*
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
* @param tcp TCP header (initialized except for CRC)
* @param payload the TCP payload
* @param payload_length number of bytes of TCP payload
/**
* Calculate IPv6 TCP checksum.
*
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
* @param tcp header (initialized except for CRC)
* @param payload the TCP payload
* @param payload_length number of bytes of TCP payload
/**
* Calculate IPv4 UDP checksum.
*
- * @param ipv4 header fully initialized
+ * @param ip ipv4 header fully initialized
* @param udp UDP header (initialized except for CRC)
* @param payload the UDP payload
* @param payload_length number of bytes of UDP payload
/**
* Calculate IPv6 UDP checksum.
*
- * @param ipv6 header fully initialized
+ * @param ip ipv6 header fully initialized
* @param udp UDP header (initialized except for CRC)
* @param payload the UDP payload
* @param payload_length number of bytes of UDP payload
/**
* Convert double to network-byte-order.
- * @param n the value in network byte order
+ * @param d the value in network byte order
* @return the same value in host byte order
*/
double
* @param dirName the name of the directory
* @param callback the method to call for each file
* @param callback_cls closure for callback
- * @return GNUNET_YES if directory is not empty and @callback
+ * @return GNUNET_YES if directory is not empty and 'callback'
* will be called later, GNUNET_NO otherwise, GNUNET_SYSERR on error.
*/
int
/**
* Creates an interprocess channel
*
- * @param blocking creates an asynchronous pipe if set to GNUNET_NO
+ * @param blocking_read creates an asynchronous pipe for reading if set to GNUNET_NO
+ * @param blocking_write creates an asynchronous pipe for writing if set to GNUNET_NO
* @param inherit_read inherit the parent processes stdin (only for windows)
* @param inherit_write inherit the parent processes stdout (only for windows)
- *
* @return handle to the new pipe, NULL on error
*/
struct GNUNET_DISK_PipeHandle *
*/
static void
helper_read (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_HELPER_Handle *h = cls;
char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE];
ssize_t t;
h->read_task = GNUNET_SCHEDULER_NO_TASK;
- if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+ if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
{
/* try again */
h->read_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
*/
static void
helper_write (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tsdkctx)
+ const struct GNUNET_SCHEDULER_TaskContext *tc)
{
struct GNUNET_HELPER_Handle *h = cls;
struct HelperMessageQueueEntry *qe;
ssize_t t;
h->write_task = GNUNET_SCHEDULER_NO_TASK;
- if (0 != (tsdkctx->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+ if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
{
/* try again */
h->write_task = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
* Destroy the mesh tunnel.
*
* @param cls the 'struct TunnelState' with the tunnel to destroy
- * @param ts schedule context
+ * @param tc scheduler context
*/
static void
destroy_tunnel_task (void *cls,
*
* @param de destination entry for which we need to setup a tunnel
* @param client client to notify on successful tunnel setup, or NULL for none
+ * @param client_af address family of the address returned to the client
* @param request_id request ID to send in client notification (unused if client is NULL)
* @return tunnel state of the tunnel that was created
*/
projects / oweals / gnunet.git / commitdiff