summaryrefslogtreecommitdiff
path: root/doc/man/fccntl.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/fccntl.3')
-rw-r--r--doc/man/fccntl.318
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/man/fccntl.3 b/doc/man/fccntl.3
index 767342b9..3dcfc2d9 100644
--- a/doc/man/fccntl.3
+++ b/doc/man/fccntl.3
@@ -76,6 +76,17 @@ buffer. Takes a \fBsize_t \fIqlen\fR * as third argument.
\fBFLOWGTXQLEN\fR - get the current number of packets in the transmit
buffer. Takes a \fBsize_t \fIqlen\fR * as third argument.
+\fBFLOWSTXQDLY\fR - set the target queueing delay for the transmit
+occupancy limiter. Takes a \fBstruct timespec * \fItimeo\fR as third
+argument. A zero delay leaves the ring unlimited, bounded only by its
+slot count. The build-time default is applied when the flow is
+created. The delay must be a normalised, non-negative timespec no
+longer than the maximum the limiter accepts.
+
+\fBFLOWGTXQDLY\fR - retrieve the current target queueing delay for
+the transmit occupancy limiter. Takes a \fBstruct timespec * \fItimeo\fR
+as third argument.
+
\fBFRCTSFLAGS\fR - set the current flow flags. Takes an \fBuint16_t
\fIflags\fR as third argument. Supported flags are:
@@ -101,12 +112,15 @@ On success, \fBfccntl\fR() returns 0.
\fBfccntl\fR() can return
.B -EINVAL
-An invalid argument was passed.
+An invalid argument was passed. This is also returned when the delay
+passed to FLOWSTXQDLY is negative, is not normalised, or exceeds the
+maximum the transmit occupancy limiter accepts.
.B -EPERM
Operation not permitted. This is returned when requesting the value of
a timeout (FLOWGSNDTIMEO or FLOWGRCVTIMEO) when no such timeout was
-set.
+set, or when FLOWSTXQDLY/FLOWGTXQDLY is used on a flow with no
+transmit occupancy ring.
.B -EBADF
Invalid flow descriptor passed.