Skip to content

Commit

Permalink
libquic: add stream_data_nodelay in quic_config in man page
Browse files Browse the repository at this point in the history
This member is used to en/disable the Nagle algorithm, and has been
implemented in the QUIC module, so add the description in man page.

While at it, also add the missing MSG_STREAM_SNDBLOCK and MSG_EOR
stream_flags.

Signed-off-by: Xin Long <[email protected]>
  • Loading branch information
lxin committed Dec 29, 2024
1 parent 52a008c commit 2df42be
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions libquic/quic.man
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,10 @@ Prevents blocking if there is no data available in the receive buffer.
The `msg_flags` field of the `msghdr` structure returned from the kernel
may be set to:

.IP \[bu] 4
.B `MSG_EOR`:
Indicates that the received data is read completely.

.IP \[bu] 4
.B `MSG_DATAGRAM`:
Indicates that the received data is an unreliable datagram.
Expand Down Expand Up @@ -264,6 +268,9 @@ Opens the next unidirectional stream.
.IP \[bu] 4
.B `MSG_STREAM_DONTWAIT`:
Opens the stream without blocking.
.IP \[bu] 4
.B `MSG_STREAM_SNDBLOCK`:
Send streams blocked when no capacity.
.RE

.TP
Expand Down Expand Up @@ -857,6 +864,7 @@ struct quic_config {
uint32_t payload_cipher_type;
uint8_t receive_session_ticket;
uint8_t certificate_request;
uint8_t stream_data_nodelay;
};
.fi
.IP "version"
Expand Down Expand Up @@ -939,6 +947,14 @@ from the client. Options include:
.IP \[bu] 4
`2`: REQUIRE
.RE
.IP "stream_data_nodelay"
Disable the Nagle algorithm. Options include:
.RS 8
.IP \[bu] 4
`0`: Enable the Nagle algorithm (default)
.IP \[bu] 4
`!0`: Disable the Nagle algorithm
.RE
.RE

.PP
Expand Down

0 comments on commit 2df42be

Please sign in to comment.