From 4d68c9fedf65188fec95205f39dad447e9b1ae44 Mon Sep 17 00:00:00 2001 From: Willow Liquorice Date: Wed, 31 Aug 2022 22:50:00 +0100 Subject: -DOC: Pass through UTIL libraries (HELPER, MST, NETWORK, OS, PEER) --- src/util/helper.c | 46 ----------------------------------------- src/util/mst.c | 14 ------------- src/util/network.c | 23 --------------------- src/util/os_installation.c | 5 ----- src/util/os_priority.c | 51 ---------------------------------------------- src/util/peer.c | 12 ----------- 6 files changed, 151 deletions(-) (limited to 'src') diff --git a/src/util/helper.c b/src/util/helper.c index 0809c1f17..09d3fffab 100644 --- a/src/util/helper.c +++ b/src/util/helper.c @@ -164,15 +164,6 @@ struct GNUNET_HELPER_Handle }; -/** - * Sends termination signal to the helper process. The helper process is not - * reaped; call GNUNET_HELPER_wait() for reaping the dead helper process. - * - * @param h the helper handle - * @param soft_kill if GNUNET_YES, signals termination by closing the helper's - * stdin; GNUNET_NO to signal termination by sending SIGTERM to helper - * @return #GNUNET_OK on success; #GNUNET_SYSERR on error - */ int GNUNET_HELPER_kill (struct GNUNET_HELPER_Handle *h, int soft_kill) { @@ -213,14 +204,6 @@ GNUNET_HELPER_kill (struct GNUNET_HELPER_Handle *h, int soft_kill) } -/** - * Reap the helper process. This call is blocking(!). The helper process - * should either be sent a termination signal before or should be dead before - * calling this function - * - * @param h the helper handle - * @return #GNUNET_OK on success; #GNUNET_SYSERR on error - */ int GNUNET_HELPER_wait (struct GNUNET_HELPER_Handle *h) { @@ -475,22 +458,6 @@ restart_task (void *cls) } -/** - * Starts a helper and begins reading from it. The helper process is - * restarted when it dies except when it is stopped using GNUNET_HELPER_stop() - * or when the exp_cb callback is not NULL. - * - * @param with_control_pipe does the helper support the use of a control pipe for signalling? - * @param binary_name name of the binary to run - * @param binary_argv NULL-terminated list of arguments to give when starting the binary (this - * argument must not be modified by the client for - * the lifetime of the helper handle) - * @param cb function to call if we get messages from the helper - * @param exp_cb the exception callback to call. Set this to NULL if the helper - * process has to be restarted automatically when it dies/crashes - * @param cb_cls closure for the above callback - * @return the new Handle, NULL on error - */ struct GNUNET_HELPER_Handle * GNUNET_HELPER_start (int with_control_pipe, const char *binary_name, @@ -644,19 +611,6 @@ helper_write (void *cls) } -/** - * Send an message to the helper. - * - * @param h helper to send message to - * @param msg message to send - * @param can_drop can the message be dropped if there is already one in the queue? - * @param cont continuation to run once the message is out (#GNUNET_OK on success, #GNUNET_NO - * if the helper process died, #GNUNET_SYSERR during #GNUNET_HELPER_destroy). - * @param cont_cls closure for @a cont - * @return NULL if the message was dropped, - * otherwise handle to cancel *cont* (actual transmission may - * not be abortable) - */ struct GNUNET_HELPER_SendHandle * GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h, const struct GNUNET_MessageHeader *msg, diff --git a/src/util/mst.c b/src/util/mst.c index 2236f2883..264fdb979 100644 --- a/src/util/mst.c +++ b/src/util/mst.c @@ -96,20 +96,6 @@ GNUNET_MST_create (GNUNET_MessageTokenizerCallback cb, } -/** - * Add incoming data to the receive buffer and call the - * callback for all complete messages. - * - * @param mst tokenizer to use - * @param buf input data to add - * @param size number of bytes in @a buf - * @param purge should any excess bytes in the buffer be discarded - * (i.e. for packet-based services like UDP) - * @param one_shot only call callback once, keep rest of message in buffer - * @return #GNUNET_OK if we are done processing (need more data) - * #GNUNET_NO if @a one_shot was set and we have another message ready - * #GNUNET_SYSERR if the data stream is corrupt - */ int GNUNET_MST_from_buffer (struct GNUNET_MessageStreamTokenizer *mst, const char *buf, diff --git a/src/util/network.c b/src/util/network.c index 2f77bc54e..7588033c4 100644 --- a/src/util/network.c +++ b/src/util/network.c @@ -561,11 +561,6 @@ GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc) } -/** - * Only free memory of a socket, keep the file descriptor untouched. - * - * @param desc socket - */ void GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc) { @@ -688,16 +683,6 @@ GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc) } -/** - * Read data from a socket (always non-blocking). - * - * @param desc socket - * @param buffer buffer - * @param length length of @a buffer - * @param src_addr either the source to recv from, or all zeroes - * to be filled in by recvfrom - * @param addrlen length of the @a src_addr - */ ssize_t GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc, void *buffer, @@ -748,14 +733,6 @@ GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, } -/** - * Send data (always non-blocking). - * - * @param desc socket - * @param buffer data to send - * @param length size of the @a buffer - * @return number of bytes sent, #GNUNET_SYSERR on error - */ ssize_t GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, const void *buffer, diff --git a/src/util/os_installation.c b/src/util/os_installation.c index 1835c6e84..7a348b42e 100644 --- a/src/util/os_installation.c +++ b/src/util/os_installation.c @@ -117,11 +117,6 @@ GNUNET_OS_project_data_get () } -/** - * Setup OS subsystem with project data. - * - * @param pd project data used to determine paths - */ void GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd) { diff --git a/src/util/os_priority.c b/src/util/os_priority.c index 2ed49b5aa..e60273814 100644 --- a/src/util/os_priority.c +++ b/src/util/os_priority.c @@ -128,14 +128,6 @@ parent_control_handler (void *cls) } -/** - * Task that connects this process to its parent via pipe; - * essentially, the parent control handler will read signal numbers - * from the #GNUNET_OS_CONTROL_PIPE (as given in an environment - * variable) and raise those signals. - * - * @param cls closure (unused) - */ void GNUNET_OS_install_parent_control_handler (void *cls) { @@ -583,17 +575,6 @@ start_process (enum GNUNET_OS_InheritStdioFlags std_inheritance, } -/** - * Start a process. - * - * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags - * @param pipe_stdin pipe to use to send input to child process (or NULL) - * @param pipe_stdout pipe to use to get output from child process (or NULL) - * @param pipe_stderr pipe to use to get output from child process (or NULL) - * @param filename name of the binary - * @param argv NULL-terminated array of arguments to the process - * @return pointer to process structure of the new process, NULL on error - */ struct GNUNET_OS_Process * GNUNET_OS_start_process_vap (enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, @@ -612,17 +593,6 @@ GNUNET_OS_start_process_vap (enum GNUNET_OS_InheritStdioFlags std_inheritance, } -/** - * Start a process. - * - * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags - * @param pipe_stdin pipe to use to send input to child process (or NULL) - * @param pipe_stdout pipe to use to get output from child process (or NULL) - * @param pipe_stderr pipe to use to get output from child process (or NULL) - * @param filename name of the binary - * @param va NULL-terminated list of arguments to the process - * @return pointer to process structure of the new process, NULL on error - */ struct GNUNET_OS_Process * GNUNET_OS_start_process_va (enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, @@ -658,16 +628,6 @@ GNUNET_OS_start_process_va (enum GNUNET_OS_InheritStdioFlags std_inheritance, } -/** - * Start a process. - * - * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags - * @param pipe_stdin pipe to use to send input to child process (or NULL) - * @param pipe_stdout pipe to use to get output from child process (or NULL) - * @param filename name of the binary - * @param ... NULL-terminated list of arguments to the process - * @return pointer to process structure of the new process, NULL on error - */ struct GNUNET_OS_Process * GNUNET_OS_start_process (enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, @@ -1127,17 +1087,6 @@ cmd_read (void *cls) } -/** - * Run the given command line and call the given function - * for each line of the output. - * - * @param proc function to call for each line of the output - * @param proc_cls closure for @a proc - * @param timeout when to time out - * @param binary command to run - * @param ... arguments to command - * @return NULL on error - */ struct GNUNET_OS_CommandHandle * GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls, diff --git a/src/util/peer.c b/src/util/peer.c index 257922f36..809efdcd5 100644 --- a/src/util/peer.c +++ b/src/util/peer.c @@ -152,12 +152,6 @@ GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid) } -/** - * Decrement multiple RCs of peer identities by one. - * - * @param ids array of PIDs to decrement the RCs of - * @param count size of the ids array - */ void GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id *ids, unsigned int count) { @@ -235,12 +229,6 @@ GNUNET_PEER_resolve (GNUNET_PEER_Id id, struct GNUNET_PeerIdentity *pid) } -/** - * Convert an interned PID to a normal peer identity. - * - * @param id interned PID to convert - * @return pointer to peer identity, valid as long 'id' is valid - */ const struct GNUNET_PeerIdentity * GNUNET_PEER_resolve2 (GNUNET_PEER_Id id) { -- cgit v1.2.3