Documentation for new cbt accessors

This commit is contained in:
Nick Mathewson 2013-08-21 12:17:20 -04:00
parent 49b8acc618
commit 79cad08b4f

View File

@ -36,24 +36,31 @@ static int unit_tests = 0;
#define unit_tests 0 #define unit_tests 0
#endif #endif
/** Return a pointer to the data structure describing our current circuit
* build time history and computations. */
const circuit_build_times_t * const circuit_build_times_t *
get_circuit_build_times(void) get_circuit_build_times(void)
{ {
return &circ_times; return &circ_times;
} }
/** As get_circuit_build_times, but return a mutable pointer. */
circuit_build_times_t * circuit_build_times_t *
get_circuit_build_times_mutable(void) get_circuit_build_times_mutable(void)
{ {
return &circ_times; return &circ_times;
} }
/** Return the time to wait before actually closing an under-construction, in
* milliseconds. */
double double
get_circuit_build_close_time_ms(void) get_circuit_build_close_time_ms(void)
{ {
return circ_times.close_ms; return circ_times.close_ms;
} }
/** Return the time to wait before giving up on an under-construction circuit,
* in milliseconds. */
double double
get_circuit_build_timeout_ms(void) get_circuit_build_timeout_ms(void)
{ {