Skip to content
Snippets Groups Projects
Commit 25bffccd authored by Alexander Hansen Færøy's avatar Alexander Hansen Færøy Committed by David Goulet
Browse files

Document enumeration values for `outbound_addr_t`.

This patch adds doxygen documentation strings for each of the values in
`outbound_addr_t`.

See: https://bugs.torproject.org/5304
parent f2968c3a
No related branches found
No related tags found
No related merge requests found
......@@ -25,9 +25,24 @@ struct routerset_t;
/** Enumeration of outbound address configuration types:
* Exit-only, OR-only, or both */
typedef enum {OUTBOUND_ADDR_EXIT, OUTBOUND_ADDR_OR,
OUTBOUND_ADDR_EXIT_AND_OR,
OUTBOUND_ADDR_MAX} outbound_addr_t;
typedef enum {
/** Outbound IP address for Exit connections. Controlled by the
* `OutboundBindAddressExit` configuration entry in torrc. */
OUTBOUND_ADDR_EXIT,
/** Outbound IP address for OR connections. Controlled by the
* `OutboundBindAddressOR` configuration entry in torrc. */
OUTBOUND_ADDR_OR,
/** Outbound IP address for both Exit and OR connections. Controlled by the
* OutboundBindAddress configuration entry in torrc. This value is used as
* fallback if the more specific OUTBOUND_ADDR_EXIT and OUTBOUND_ADDR_OR is
* unset. */
OUTBOUND_ADDR_EXIT_AND_OR,
/** Max value for this enum. Must be the last element in this enum. */
OUTBOUND_ADDR_MAX
} outbound_addr_t;
/** Which protocol to use for TCPProxy. */
typedef enum {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment