summaryrefslogtreecommitdiff
path: root/src/common/compat_libevent.c
diff options
context:
space:
mode:
authorSebastian Hahn <sebastian@torproject.org>2010-04-04 03:34:42 +0200
committerNick Mathewson <nickm@torproject.org>2010-09-27 14:22:18 -0400
commit865bea3b895831a486b024e90f58d72d025ce284 (patch)
tree2e41a80cff9959d8b25f896b0d82398ab4b1ea16 /src/common/compat_libevent.c
parentbeb52352f2aeefb69ae2ee67e4e456346e28e40e (diff)
downloadtor-865bea3b895831a486b024e90f58d72d025ce284.tar.gz
tor-865bea3b895831a486b024e90f58d72d025ce284.zip
Some bufferevents related fixes and pointers for nickm
Diffstat (limited to 'src/common/compat_libevent.c')
-rw-r--r--src/common/compat_libevent.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/common/compat_libevent.c b/src/common/compat_libevent.c
index 2ae280e669..ee8b5b561b 100644
--- a/src/common/compat_libevent.c
+++ b/src/common/compat_libevent.c
@@ -554,7 +554,9 @@ periodic_timer_free(periodic_timer_t *timer)
#ifdef USE_BUFFEREVENTS
static const struct timeval *one_tick = NULL;
/**
- DOCDOC
+ * Return a special timeout to be passed whenever libevent's O(1) timeout
+ * implementation should be used. Only use this when the timer is supposed
+ * to fire after 1 / TOR_LIBEVENT_TICKS_PER_SECOND seconds have passed.
*/
const struct timeval *tor_libevent_get_one_tick_timeout(void)
{