diff options
| author | Nick Mathewson <nickm@torproject.org> | 2008-02-11 01:09:24 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2008-02-11 01:09:24 +0000 |
| commit | 65ee9dc5852fb8eaada7ff3e6f72249b7ceeef3f (patch) | |
| tree | 3096be2b7659ea2e8bc46d7fcb3cf1b841be3694 /src/or/connection_or.c | |
| parent | ab0c85eea656ad6659c2df48795e2fe28f2a2209 (diff) | |
| download | tor-65ee9dc5852fb8eaada7ff3e6f72249b7ceeef3f.tar.gz tor-65ee9dc5852fb8eaada7ff3e6f72249b7ceeef3f.zip | |
r14108@tombo: nickm | 2008-02-10 20:09:10 -0500
add some documentation
svn:r13462
Diffstat (limited to 'src/or/connection_or.c')
| -rw-r--r-- | src/or/connection_or.c | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/or/connection_or.c b/src/or/connection_or.c index 2cd7fb6517..9950bebb9a 100644 --- a/src/or/connection_or.c +++ b/src/or/connection_or.c @@ -846,7 +846,8 @@ connection_tls_finish_handshake(or_connection_t *conn) } } -/** DOCDOC */ +/** Allocate a new connection handshake state for the connection + * <b>conn</b>. Return 0 on success, -1 on failure. */ static int connection_init_or_handshake_state(or_connection_t *conn, int started_here) { @@ -856,7 +857,7 @@ connection_init_or_handshake_state(or_connection_t *conn, int started_here) return 0; } -/** DOCDOC */ +/** Free all storage held by <b>state</b>. */ void or_handshake_state_free(or_handshake_state_t *state) { @@ -865,7 +866,9 @@ or_handshake_state_free(or_handshake_state_t *state) tor_free(state); } -/**DOCDOC*/ +/** Set <b>conn</b>'s state to OR_CONN_STATE_OPEN, and tell other subsystems + * as appropriate. Called when we are done with all TLS and OR handshaking. + */ int connection_or_set_state_open(or_connection_t *conn) { |