diff options
| author | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
| commit | cb1a3674ebb3826d9e1e56146210bd79cb4a42f0 (patch) | |
| tree | 84382a222e7d271efb8426560b61fb1a28ec4e05 /src/lib/net/alertsock.c | |
| parent | 83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff) | |
| download | tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip | |
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/net/alertsock.c')
| -rw-r--r-- | src/lib/net/alertsock.c | 11 |
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" |