aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-10-07 18:36:54 +0000
committerChristian Grothoff <christian@grothoff.org>2013-10-07 18:36:54 +0000
commitb5a7569e6ffce565fc118714866044376fec70ae (patch)
tree2f51ab97c0e63b91b096c420300caa1fa3bef12a /src/include
parent5f516f44aeb2777c7c11f6e79ad392559d898cc3 (diff)
downloadgnunet-b5a7569e6ffce565fc118714866044376fec70ae.tar.gz
gnunet-b5a7569e6ffce565fc118714866044376fec70ae.zip
-doxygen
Diffstat (limited to 'src/include')
-rw-r--r--src/include/gnunet_os_lib.h30
1 files changed, 15 insertions, 15 deletions
diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h
index 04fc1a406..2944f8dfb 100644
--- a/src/include/gnunet_os_lib.h
+++ b/src/include/gnunet_os_lib.h
@@ -195,7 +195,7 @@ enum GNUNET_OS_ProcessStatusType
195 195
196/** 196/**
197 * Get the path to a specific GNUnet installation directory or, with 197 * Get the path to a specific GNUnet installation directory or, with
198 * GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation 198 * #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation
199 * directory. 199 * directory.
200 * 200 *
201 * @param dirkind what kind of directory is desired? 201 * @param dirkind what kind of directory is desired?
@@ -227,22 +227,22 @@ GNUNET_OS_get_libexec_binary_path (const char *progname);
227 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned) 227 * @param broadcast_addr the broadcast address (can be NULL for unknown or unassigned)
228 * @param netmask the network mask (can be NULL for unknown or unassigned)) 228 * @param netmask the network mask (can be NULL for unknown or unassigned))
229 * @param addrlen length of the address 229 * @param addrlen length of the address
230 * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort 230 * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
231 */ 231 */
232typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name, 232typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
233 const char *name,
233 int isDefault, 234 int isDefault,
234 const struct sockaddr * 235 const struct sockaddr *addr,
235 addr, 236 const struct sockaddr *broadcast_addr,
236 const struct sockaddr * 237 const struct sockaddr *netmask,
237 broadcast_addr, 238 socklen_t addrlen);
238 const struct sockaddr *
239 netmask, socklen_t addrlen);
240 239
241 240
242/** 241/**
243 * @brief Enumerate all network interfaces 242 * @brief Enumerate all network interfaces
243 *
244 * @param proc the callback function 244 * @param proc the callback function
245 * @param proc_cls closure for proc 245 * @param proc_cls closure for @a proc
246 */ 246 */
247void 247void
248GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc, 248GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
@@ -428,7 +428,7 @@ GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
428 * @param proc pointer to process structure 428 * @param proc pointer to process structure
429 * @param type status type 429 * @param type status type
430 * @param code return code/signal number 430 * @param code return code/signal number
431 * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise 431 * @return #GNUNET_OK on success, #GNUNET_NO if the process is still running, #GNUNET_SYSERR otherwise
432 */ 432 */
433int 433int
434GNUNET_OS_process_status (struct GNUNET_OS_Process *proc, 434GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
@@ -444,7 +444,7 @@ GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
444 * or to terminate very soon. 444 * or to terminate very soon.
445 * 445 *
446 * @param proc pointer to process structure of the process to wait for 446 * @param proc pointer to process structure of the process to wait for
447 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise 447 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
448 */ 448 */
449int 449int
450GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc); 450GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
@@ -478,9 +478,9 @@ GNUNET_OS_install_parent_control_handler (void *cls,
478 * binary with the -d flag. -d omits a programs main loop and only 478 * binary with the -d flag. -d omits a programs main loop and only
479 * executes all privileged operations in an binary. 479 * executes all privileged operations in an binary.
480 * @param params parameters used for w32 privilege checking (can be NULL for != w32, or when not checking for suid/permissions ) 480 * @param params parameters used for w32 privilege checking (can be NULL for != w32, or when not checking for suid/permissions )
481 * @return GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32), 481 * @return #GNUNET_YES if the file is SUID (*nix) or can be executed with current privileges (W32),
482 * GNUNET_NO if not SUID (but binary exists), 482 * #GNUNET_NO if not SUID (but binary exists),
483 * GNUNET_SYSERR on error (no such binary or not executable) 483 * #GNUNET_SYSERR on error (no such binary or not executable)
484 */ 484 */
485int 485int
486GNUNET_OS_check_helper_binary (const char *binary, int check_suid, const char * params); 486GNUNET_OS_check_helper_binary (const char *binary, int check_suid, const char * params);