diff options
| author | Nick Mathewson <nickm@torproject.org> | 2016-10-18 12:25:55 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2016-10-18 12:25:55 -0400 |
| commit | d1b45786b1f91d3a65e88cc99c8021ea9d25a106 (patch) | |
| tree | 5e2a18c7653031e1b04fe946a64c09535bcd7e38 /src/or/connection_or.c | |
| parent | 84829e336c3f72e4926e90d6f2e58eed0a538bce (diff) | |
| download | tor-d1b45786b1f91d3a65e88cc99c8021ea9d25a106.tar.gz tor-d1b45786b1f91d3a65e88cc99c8021ea9d25a106.zip | |
Document connection_or.c and connection.c at module level
Diffstat (limited to 'src/or/connection_or.c')
| -rw-r--r-- | src/or/connection_or.c | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/or/connection_or.c b/src/or/connection_or.c index 72d8e13e90..267c32dda4 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -8,6 +8,17 @@ * \file connection_or.c * \brief Functions to handle OR connections, TLS handshaking, and * cells on the network. + * + * An or_connection_t is a subtype of connection_t (as implemented in + * connection.c) that uses a TLS connection to send and receive cells on the + * Tor network. (By sending and receiving cells connection_or.c, it cooperates + * with channeltls.c to implement a the channel interface of channel.c.) + * + * Every OR connection has an underlying tortls_t object (as implemented in + * tortls.c) which it uses as its TLS stream. It is responsible for + * sending and receiving cells over that TLS. + * + * This module also implements the client side of the v3 Tor link handshake, **/ #include "or.h" #include "buffers.h" |