nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 12:23:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

HACKING/design: move 01c-time.md into doxygen.

Browse Source
This commit is contained in:
Nick Mathewson 2019-11-12 12:14:14 -05:00
parent b0f9ecdbb1
commit 6744f6b6bb
2 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/HACKING/design/01c-time.md → src/lib/evloop/time_periodic.dox
View File

@ -1,5 +1,6 @@
/**
## Time in tor ## @page time_periodic Time and periodic events in Tor
### What time is it? ### ### What time is it? ###
@ -33,28 +34,28 @@ tor_gettimeofday_cached().
Tor has functions to parse and format time in these formats: Tor has functions to parse and format time in these formats:
* RFC1123 format. ("Fri, 29 Sep 2006 15:54:20 GMT"). For this, - RFC1123 format. ("Fri, 29 Sep 2006 15:54:20 GMT"). For this,
use format_rfc1123_time() and parse_rfc1123_time. use format_rfc1123_time() and parse_rfc1123_time.
* ISO8601 format. ("2006-10-29 10:57:20") For this, use - ISO8601 format. ("2006-10-29 10:57:20") For this, use
format_local_iso_time and format_iso_time. We also support the format_local_iso_time() and format_iso_time(). We also support the
variant format "2006-10-29T10:57:20" with format_iso_time_nospace, and variant format "2006-10-29T10:57:20" with format_iso_time_nospace(), and
"2006-10-29T10:57:20.123456" with format_iso_time_nospace_usec. "2006-10-29T10:57:20.123456" with format_iso_time_nospace_usec().
* HTTP format collections (preferably "Mon, 25 Jul 2016 04:01:11 - HTTP format collections (preferably "Mon, 25 Jul 2016 04:01:11
GMT" or possibly "Wed Jun 30 21:49:08 1993" or even "25-Jul-16 GMT" or possibly "Wed Jun 30 21:49:08 1993" or even "25-Jul-16
04:01:11 GMT"). For this, use parse_http_time. Don't generate anything 04:01:11 GMT"). For this, use parse_http_time(). Don't generate anything
but the first format. but the first format.
Some of these functions use struct tm. You can use the standard Some of these functions use struct tm. You can use the standard
tor_localtime_r and tor_gmtime_r() to wrap these in a safe way. We tor_localtime_r() and tor_gmtime_r() to wrap these in a safe way. We
also have a tor_timegm() function. also have a tor_timegm() function.
### Scheduling events ### ### Scheduling events ###
The main way to schedule a not-too-frequent periodic event with The main way to schedule a not-too-frequent periodic event with
respect to the Tor mainloop is via the mechanism in periodic.c. respect to the Tor mainloop is via the mechanism in periodic.c.
There's a big table of periodic_events in main.c, each of which gets There's a big table of periodic_events in mainloop.c, each of which gets
invoked on its own schedule. You should not expect more than about invoked on its own schedule. You should not expect more than about
one second of accuracy with these timers. one second of accuracy with these timers.
@ -73,3 +74,5 @@ accurate within a handful of milliseconds -- possibly better on some
platforms. (The timers.c module uses William Ahern's timeout.c platforms. (The timers.c module uses William Ahern's timeout.c
implementation as its backend, which is based on a hierarchical timing implementation as its backend, which is based on a hierarchical timing
wheel algorithm. It's cool stuff; check it out.) wheel algorithm. It's cool stuff; check it out.)
**/

2
src/mainpage.dox
View File

@ -38,6 +38,8 @@ Tor repository.
@subpage strings @subpage strings
@subpage time_periodic
**/ **/
/** /**