centos man page for tevent_helpers

The tevent helper functiions(3) 				      tevent					   The tevent helper functiions(3)

NAME
       The tevent helper functiions -

   Functions
       int tevent_timeval_compare (const struct timeval *tv1, const struct timeval *tv2)
	   Compare two timeval values.
       struct timeval tevent_timeval_zero (void)
	   Get a zero timval value.
       struct timeval tevent_timeval_current (void)
	   Get a timeval value for the current time.
       struct timeval tevent_timeval_set (uint32_t secs, uint32_t usecs)
	   Get a timeval structure with the given values.
       struct timeval tevent_timeval_until (const struct timeval *tv1, const struct timeval *tv2)
	   Get the difference between two timeval values.
       bool tevent_timeval_is_zero (const struct timeval *tv)
	   Check if a given timeval structure is zero.
       struct timeval tevent_timeval_add (const struct timeval *tv, uint32_t secs, uint32_t usecs)
	   Add the given amount of time to a timeval structure.
       struct timeval tevent_timeval_current_ofs (uint32_t secs, uint32_t usecs)
	   Get a timeval in the future with a specified offset from now.

Detailed Description
       Todo
	   description

Function Documentation
   struct timeval tevent_timeval_add (const struct timeval *tv, uint32_tsecs, uint32_tusecs)
       Add the given amount of time to a timeval structure.

       Parameters:
	   tv The timeval structure to add the time.
	   secs The seconds to add to the timeval.
	   usecs The microseconds to add to the timeval.

       Returns:
	   The timeval structure with the new time.

   int tevent_timeval_compare (const struct timeval *tv1, const struct timeval *tv2)
       Compare two timeval values.

       Parameters:
	   tv1 The first timeval value to compare.
	   tv2 The second timeval value to compare.

       Returns:
	   0 if they are equal. 1 if the first time is greater than the second. -1 if the first time is smaller than the second.

       Compare two timeval values.

       Return -1 if tv1 < tv2 Return 0 if tv1 == tv2 Return 1 if tv1 > tv2

   struct timeval tevent_timeval_current (void)
       Get a timeval value for the current time.

       Returns:
	   A timval value with the current time.

       Get a timeval value for the current time.

   struct timeval tevent_timeval_current_ofs (uint32_tsecs, uint32_tusecs)
       Get a timeval in the future with a specified offset from now.

       Parameters:
	   secs The seconds of the offset from now.
	   usecs The microseconds of the offset from now.

       Returns:
	   A timval with the given offset in the future.

       Get a timeval in the future with a specified offset from now.

   bool tevent_timeval_is_zero (const struct timeval *tv)
       Check if a given timeval structure is zero.

       Parameters:
	   tv The timeval to check if it is zero.

       Returns:
	   True if it is zero, false otherwise.

       Check if a given timeval structure is zero.

   struct timeval tevent_timeval_set (uint32_tsecs, uint32_tusecs)
       Get a timeval structure with the given values.

       Parameters:
	   secs The seconds to set.
	   usecs The microseconds to set.

       Returns:
	   A timeval structure with the given values.

       Get a timeval structure with the given values.

   struct timeval tevent_timeval_until (const struct timeval *tv1, const struct timeval *tv2)
       Get the difference between two timeval values.

       Parameters:
	   tv1 The first timeval.
	   tv2 The second timeval.

       Returns:
	   A timeval structure with the difference between the first and the second value.

       Get the difference between two timeval values.

   struct timeval tevent_timeval_zero (void)
       Get a zero timval value.

       Returns:
	   A zero timval value.

       Get a zero timval value.

Author
       Generated automatically by Doxygen for tevent from the source code.

Version 0.9.8							  Tue Jun 17 2014				   The tevent helper functiions(3)