X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/365a7a282a28586b000dc3cfce7900007415bbd7..94c5a08ebdc03125f84e7fed814a1599c788a09e:/doc/gettime.md diff --git a/doc/gettime.md b/doc/gettime.md index 72280ee..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) + +## `source` + +The library/function currently in use. -Uses the most accurate method available (in order:) +## `resolution` + +The smallest time resolution (in seconds) available from `gettime ( )` . + +## `gettime ( )` - - luasocket's `socket.gettime` - - `os.time` +Returns the number of seconds since unix epoch (1970-01-01T00:00:00Z) as a lua number