From dc9151d35517d82769028c7dd81e0d7cc527a270 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 17 May 2006 20:43:19 +0000 Subject: * add doxygen docs to header file * add C++ macros to header file git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@920 fefdeb5f-60dc-0310-8127-8f9354f1896f --- src/polyp/util.h | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) (limited to 'src/polyp/util.h') diff --git a/src/polyp/util.h b/src/polyp/util.h index 37232d9f..8bd03f98 100644 --- a/src/polyp/util.h +++ b/src/polyp/util.h @@ -26,23 +26,54 @@ #include #include +#include + +/** \file + * Assorted utility functions */ + +PA_C_DECL_BEGIN struct timeval; +/** Return the current username in the specified string buffer. */ char *pa_get_user_name(char *s, size_t l); + +/** Return the current hostname in the specified buffer. */ char *pa_get_host_name(char *s, size_t l); + +/** Return the fully qualified domain name in s */ char *pa_get_fqdn(char *s, size_t l); + +/** Return the home directory of the current user */ char *pa_get_home_dir(char *s, size_t l); +/** Return the binary file name of the current process. This is not + * supported on all architectures, in which case NULL is returned. */ char *pa_get_binary_name(char *s, size_t l); + +/** Return a pointer to the filename inside a path (which is the last + * component). */ const char *pa_path_get_filename(const char *p); +/** Return the current timestamp, just like UNIX gettimeofday() */ struct timeval *pa_gettimeofday(struct timeval *tv); + +/** Calculate the difference between the two specified timeval + * structs. */ pa_usec_t pa_timeval_diff(const struct timeval *a, const struct timeval *b); + +/** Compare the two timeval structs and return 0 when equal, negative when a < b, positive otherwse */ int pa_timeval_cmp(const struct timeval *a, const struct timeval *b); + +/** Return the time difference between now and the specified timestamp */ pa_usec_t pa_timeval_age(const struct timeval *tv); -void pa_timeval_add(struct timeval *tv, pa_usec_t v); +/** Add the specified time inmicroseconds to the specified timeval structure */ +struct timeval* pa_timeval_add(struct timeval *tv, pa_usec_t v); + +/** Wait t milliseconds */ int pa_msleep(unsigned long t); +PA_C_DECL_END + #endif -- cgit