aboutsummaryrefslogtreecommitdiff
path: root/src/lib/net/alertsock.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/net/alertsock.c')
-rw-r--r--src/lib/net/alertsock.c11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lib/net/alertsock.c b/src/lib/net/alertsock.c
index c6ea1551f8..340f9513fb 100644
--- a/src/lib/net/alertsock.c
+++ b/src/lib/net/alertsock.c
@@ -3,6 +3,17 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file alertsock.c
+ *
+ * \brief Use a socket to alert the main thread from a worker thread.
+ *
+ * Because our main loop spends all of its time in select, epoll, kqueue, or
+ * etc, we need a way to wake up the main loop from another thread. This code
+ * tries to provide the fastest reasonable way to do that, depending on our
+ * platform.
+ **/
+
#include "orconfig.h"
#include "lib/net/alertsock.h"
#include "lib/net/socket.h"