summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/flow_read.36
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/man/flow_read.3 b/doc/man/flow_read.3
index 96f76766..0110d0a2 100644
--- a/doc/man/flow_read.3
+++ b/doc/man/flow_read.3
@@ -30,7 +30,11 @@ from the supplied buffer \fIbuf\fR to the flow specified by \fIfd\fR.
.SH RETURN VALUE
On success, \fBflow_read\fR() returns the number of bytes read. On
-failure, a negative value indicating the error will be returned.
+failure, a negative value indicating the error will be returned. If
+the number of bytes read equals count, a subsequent call to
+\fBflow_read\fR() should be performed to check if there were more
+bytes to read. This call to \fBflow_read\fR will return 0 if there
+was no more data and mark the end of the datagram.
On success, \fBflow_write\fR() returns 0. On failure, a negative value
indicating the error will be returned. Passing a NULL pointer for