aboutsummaryrefslogtreecommitdiff
path: root/src/or/relay.c
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2012-11-14 22:55:23 -0500
committerNick Mathewson <nickm@torproject.org>2012-11-14 23:16:58 -0500
commite3ceac38d9d7b731abe5605d13735ee051eff623 (patch)
treee6bdfcce7270cd7de3e205cc37d5e22df7dfedf3 /src/or/relay.c
parentd643487cc24c9f8d7c56cdf961a1e5598339538c (diff)
downloadtor-e3ceac38d9d7b731abe5605d13735ee051eff623.tar
tor-e3ceac38d9d7b731abe5605d13735ee051eff623.tar.gz
Add another missing function doc
Diffstat (limited to 'src/or/relay.c')
-rw-r--r--src/or/relay.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/or/relay.c b/src/or/relay.c
index 79eb91936..d862e5834 100644
--- a/src/or/relay.c
+++ b/src/or/relay.c
@@ -858,7 +858,11 @@ remap_event_helper(entry_connection_t *conn, const tor_addr_t *new_addr)
REMAP_STREAM_SOURCE_EXIT);
}
-/**DOCDOC*/
+/** Extract the contents of a connected cell in <b>cell</b>, whose relay
+ * header has already been parsed into <b>rh</b>. On success, set
+ * <b>addr_out</b> to the address we're connected to, and <b>ttl_out</b> to
+ * the ttl of that address, in seconds, and return 0. On failure, return
+ * -1. */
int
connected_cell_parse(const relay_header_t *rh, const cell_t *cell,
tor_addr_t *addr_out, int *ttl_out)