Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tevent_helpers(3) [centos man page]

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)

Check Out this Related Man Page

timeradd(3C)						   Standard C Library Functions 					      timeradd(3C)

NAME

       timeradd, timersub, timerclear, timerisset, timercmp - operations on timeval structures

SYNOPSIS

       #include <sys/time.h>

       void timeradd(struct timeval *a, struct timeval *b,
	    struct timeval *res);

       void timerclear(struct timeval *tvp);

       int timercmp(struct timeval *a, struct timeval *b, CMP);

       int timerisset(struct timeval *tvp);

       void timersub(struct timeval *a, struct timeval *b,
	    struct timeval *res);

DESCRIPTION

       These macros are provided for manipulating timeval structures for use with gettimeofday(3C) and settimeofday(3C) operands. The structure is
       defined in <sys/time.h> as:

	 struct timeval {
	     long    tv_sec;	 /* seconds since Jan. 1, 1970 */
	     long    tv_usec;	 /* and microseconds */
	 };

       The timeradd() macro adds the time information stored in a to b and stores the resulting timeval in res. The results  are  simplified  such
       that the value of res->tv_usec is always less than 1,000,000 (1 second).

       The timersub() macro subtracts the time information stored in b from a and stores the resulting timeval in res.

       The timerclear() macro initializes tvp to midnight (0 hour) January 1st, 1970 (the Epoch).

       The timerisset() macro returns true if tvp is set to any time value other than the Epoch.

       The timercmp() macro compares a to b using the form a CMP b, where CMP is one of <, <=, ==, !=, >=, or >.

USAGE

       These macros are not available in function form. All of these macros evaluate their arguments more than once. If parameters passed to these
       macros are expressions with side effects, the results are undefined.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe with Exceptions	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       gettimeofday(3C), attributes(5)

SunOS 5.11							    12 Jun 2008 						      timeradd(3C)
Man Page