diff options
Diffstat (limited to 'include/git2/sys')
-rw-r--r-- | include/git2/sys/time.h | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/include/git2/sys/time.h b/include/git2/sys/time.h new file mode 100644 index 000000000..e4f87e6e1 --- /dev/null +++ b/include/git2/sys/time.h @@ -0,0 +1,31 @@ +/* + * Copyright (C) the libgit2 contributors. All rights reserved. + * + * This file is part of libgit2, distributed under the GNU GPL v2 with + * a Linking Exception. For full terms see the included COPYING file. + */ +#ifndef INCLUDE_git_time_h__ +#define INCLUDE_git_time_h__ + +#include "git2/common.h" + +GIT_BEGIN_DECL + +/** + * Return a monotonic time value, useful for measuring running time + * and setting up timeouts. + * + * The returned value is an arbitrary point in time -- it can only be + * used when comparing it to another `git_time_monotonic` call. + * + * The time is returned in seconds, with a decimal fraction that differs + * on accuracy based on the underlying system, but should be least + * accurate to Nanoseconds. + * + * This function cannot fail. + */ +GIT_EXTERN(double) git_time_monotonic(void); + +GIT_END_DECL +#endif + |