aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2017-03-17 11:31:21 -0400
committerNick Mathewson <nickm@torproject.org>2017-03-28 19:55:03 +0200
commit436b975e213aaf0abe12e0fe035b7b83bcb2198a (patch)
treea8ad1f9be3dc5041aaaa2a812302e95f62532c50 /src
parent8aa69a1b69b64185333fb1b6e74d55fc5e341fd8 (diff)
downloadtor-436b975e213aaf0abe12e0fe035b7b83bcb2198a.tar.gz
tor-436b975e213aaf0abe12e0fe035b7b83bcb2198a.zip
Improve documentation for connection_dirserv_flushed_some.
Diffstat (limited to 'src')
-rw-r--r--src/or/dirserv.c10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/or/dirserv.c b/src/or/dirserv.c
index bf01dce373..33d25618fa 100644
--- a/src/or/dirserv.c
+++ b/src/or/dirserv.c
@@ -3740,8 +3740,14 @@ get_signed_descriptor_by_fp(const uint8_t *fp, int extrainfo)
* below this threshold. */
#define DIRSERV_BUFFER_MIN 16384
-/** Called whenever we have flushed some directory data in state
- * SERVER_WRITING. */
+/**
+ * Called whenever we have flushed some directory data in state
+ * SERVER_WRITING, or whenever we want to fill the buffer with initial
+ * directory data (so that subsequent writes will occur, and trigger this
+ * function again.)
+ *
+ * Return 0 on success, and -1 on failure.
+ */
int
connection_dirserv_flushed_some(dir_connection_t *conn)
{