torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document enumeration values for outbound_addr_t.

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

See: https://bugs.torproject.org/5304
This commit is contained in:
Alexander Færøy
2019-07-02 18:49:44 +02:00
committed by David Goulet
parent f2968c3aac
commit 25bffccd71
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/app/config/or_options_st.h
+18 -3
View File
@@ -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 {