aboutsummaryrefslogtreecommitdiff
path: root/src/or/entrynodes.c
diff options
context:
space:
mode:
authorGeorge Kadianakis <desnacked@riseup.net>2016-12-06 14:34:48 -0500
committerNick Mathewson <nickm@torproject.org>2016-12-16 11:06:22 -0500
commit7ab2678074e5d49628d948fadb80c5904950236c (patch)
tree2f0b34c15bdb07481c5e20524c25c46f98a0deee /src/or/entrynodes.c
parent68679504323b0a676a446b8fb34b976c9dc66b4f (diff)
downloadtor-7ab2678074e5d49628d948fadb80c5904950236c.tar.gz
tor-7ab2678074e5d49628d948fadb80c5904950236c.zip
Trivial documentation improvements.
Diffstat (limited to 'src/or/entrynodes.c')
-rw-r--r--src/or/entrynodes.c17
1 files changed, 13 insertions, 4 deletions
diff --git a/src/or/entrynodes.c b/src/or/entrynodes.c
index 76070a3b7d..a28603d98d 100644
--- a/src/or/entrynodes.c
+++ b/src/or/entrynodes.c
@@ -142,7 +142,9 @@
#include "transports.h"
#include "statefile.h"
+/** A list of existing guard selection contexts. */
static smartlist_t *guard_contexts = NULL;
+/** The currently enabled guard selection context. */
static guard_selection_t *curr_guard_context = NULL;
/** A value of 1 means that at least one context has changed,
@@ -593,7 +595,8 @@ choose_guard_selection(const or_options_t *options,
"rest of the world.", (int)(exclude_frac * 100));
}
- /* Easy case: no previous selection */
+ /* Easy case: no previous selection. Just check if we are in restricted or
+ normal guard selection. */
if (old_selection == NULL) {
if (n_passing_filter >= meaningful_threshold_mid) {
*type_out = GS_TYPE_NORMAL;
@@ -768,8 +771,9 @@ entry_guard_add_to_sample(guard_selection_t *gs,
/**
* Backend: adds a new sampled guard to <b>gs</b>, with given identity,
- * nickname, and ORPort. rsa_id_digest and bridge_addrport are
- * optional, but we need one of them. nickname is optional.
+ * nickname, and ORPort. rsa_id_digest and bridge_addrport are optional, but
+ * we need one of them. nickname is optional. The caller is responsible for
+ * maintaining the size limit of the SAMPLED_GUARDS set.
*/
static entry_guard_t *
entry_guard_add_to_sample_impl(guard_selection_t *gs,
@@ -2171,7 +2175,8 @@ entry_guards_all_primary_guards_are_down(guard_selection_t *gs)
}
/** Wrapper for entry_guard_has_higher_priority that compares the
- * guard-priorities of a pair of circuits.
+ * guard-priorities of a pair of circuits. Return 1 if <b>a</b> has higher
+ * priority than <b>b</b>.
*
* If a restriction is provided in <b>rst</b>, then do not consider
* <b>a</b> to have higher priority if it violates the restriction.
@@ -4180,6 +4185,8 @@ choose_random_entry_impl(guard_selection_t *gs,
}
#endif
+/** Check the pathbias use success count of <b>node</b> and disable it if it
+ * goes over our thresholds. */
static void
pathbias_check_use_success_count(entry_guard_t *node)
{
@@ -4201,6 +4208,8 @@ pathbias_check_use_success_count(entry_guard_t *node)
}
}
+/** Check the pathbias close count of <b>node</b> and disable it if it goes
+ * over our thresholds. */
static void
pathbias_check_close_success_count(entry_guard_t *node)
{