From 232861ba42c176a98fdaa2792ae2930a759723f1 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Sat, 11 Jun 2005 18:52:12 +0000 Subject: Docment or add DOCDOC comments to undocumented functions in src/or. Make function definition format uniform. svn:r4411 --- src/tools/tor-resolve.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src/tools') diff --git a/src/tools/tor-resolve.c b/src/tools/tor-resolve.c index 1e8dcd6d1..19932467b 100644 --- a/src/tools/tor-resolve.c +++ b/src/tools/tor-resolve.c @@ -44,6 +44,9 @@ do { log_fn(LOG_ERR, "Error while %s: %s", act, \ tor_socket_strerror(tor_socket_errno(_s))); } while (0) +/** Set *out to a newly allocated SOCKS4a resolve request with + * username and hostname as provided. Return the number of bytes in + * the request. */ static int build_socks4a_resolve_request(char **out, const char *username, @@ -66,6 +69,9 @@ build_socks4a_resolve_request(char **out, return len; } +/** Given a len-byte SOCKS4a response in response, set *addr_out to the + * address it contains (in host order). Return 0 on success, -1 on error. + */ static int parse_socks4a_resolve_response(const char *response, size_t len, uint32_t *addr_out) @@ -96,6 +102,10 @@ parse_socks4a_resolve_response(const char *response, size_t len, return 0; } +/** Send a resolve request for hostname to the Tor listening on + * sockshost:socksport. Store the resulting IPv4 + * address (in host order) into result_addr. + */ static int do_resolve(const char *hostname, uint32_t sockshost, uint16_t socksport, uint32_t *result_addr) @@ -163,6 +173,7 @@ do_resolve(const char *hostname, uint32_t sockshost, uint16_t socksport, return 0; } +/** Print a usage message and exit. */ static void usage(void) { @@ -170,6 +181,7 @@ usage(void) exit(1); } +/** Entry point to tor-resolve */ int main(int argc, char **argv) { -- cgit v1.2.3