X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/33e6d576521eb23df0e11944616af37fb261f121..f2fc0b840b9b1ce58e8c9ca0a858f613bb3bd8be:/doc/gettime.md diff --git a/doc/gettime.md b/doc/gettime.md index 76eddfb..2e3ef35 100644 --- a/doc/gettime.md +++ b/doc/gettime.md @@ -2,10 +2,22 @@ A module to get the current time. +Uses the most precise method available (in order:) -## `gettime` + - Use [ljsyscall](http://www.myriabit.com/ljsyscall/) to access + - `clock_gettime(2)` called with `CLOCK_REALTIME` + - `gettimeofday(2)` + - [luasocket](http://w3.impa.br/~diego/software/luasocket/)'s `socket.gettime` + - [`os.time`](http://www.lua.org/manual/5.2/manual.html#pdf-os.time) -Uses the most accurate method available (in order:) +## `source` - - Uses luasocket's `socket.gettime` if available - - `os.time` +The library/function currently in use. + +## `resolution` + +The smallest time resolution (in seconds) available from `gettime ( )` . + +## `gettime ( )` + +Returns the number of seconds since unix epoch (1970-01-01T00:00:00Z) as a lua number