@@ -4287,7 +4287,13 @@ NGTCP2_EXTERN int ngtcp2_conn_open_uni_stream(ngtcp2_conn *conn,
42874287 * deletion is done when the remote endpoint sends acknowledgement.
42884288 * Calling this function is equivalent to call
42894289 * `ngtcp2_conn_shutdown_stream_read`, and
4290- * `ngtcp2_conn_shutdown_stream_write` sequentially.
4290+ * `ngtcp2_conn_shutdown_stream_write` sequentially with the following
4291+ * differences. If |stream_id| refers to a local unidirectional
4292+ * stream, this function only shutdowns write side of the stream. If
4293+ * |stream_id| refers to a remote unidirectional stream, this function
4294+ * only shutdowns read side of the stream.
4295+ *
4296+ * |flags| is currently unused, and should be set to 0.
42914297 *
42924298 * This function returns 0 if it succeeds, or one of the following
42934299 * negative error codes:
@@ -4305,9 +4311,11 @@ NGTCP2_EXTERN int ngtcp2_conn_shutdown_stream(ngtcp2_conn *conn,
43054311 * `ngtcp2_conn_shutdown_stream_write` closes write-side of stream
43064312 * denoted by |stream_id| abruptly. |app_error_code| is one of
43074313 * application error codes, and indicates the reason of shutdown. If
4308- * this function succeeds, no application data is sent to the remote
4309- * endpoint. It discards all data which has not been acknowledged
4310- * yet.
4314+ * this function succeeds, no further application data is sent to the
4315+ * remote endpoint. It discards all data which has not been
4316+ * acknowledged yet.
4317+ *
4318+ * |flags| is currently unused, and should be set to 0.
43114319 *
43124320 * This function returns 0 if it succeeds, or one of the following
43134321 * negative error codes:
@@ -4325,8 +4333,10 @@ NGTCP2_EXTERN int ngtcp2_conn_shutdown_stream_write(ngtcp2_conn *conn,
43254333 * `ngtcp2_conn_shutdown_stream_read` closes read-side of stream
43264334 * denoted by |stream_id| abruptly. |app_error_code| is one of
43274335 * application error codes, and indicates the reason of shutdown. If
4328- * this function succeeds, no application data is forwarded to an
4329- * application layer.
4336+ * this function succeeds, no further application data is forwarded to
4337+ * an application layer.
4338+ *
4339+ * |flags| is currently unused, and should be set to 0.
43304340 *
43314341 * This function returns 0 if it succeeds, or one of the following
43324342 * negative error codes:
@@ -4649,8 +4659,10 @@ NGTCP2_EXTERN int ngtcp2_conn_is_in_draining_period(ngtcp2_conn *conn);
46494659/**
46504660 * @function
46514661 *
4652- * `ngtcp2_conn_extend_max_stream_offset` extends stream's max stream
4653- * data value by |datalen|.
4662+ * `ngtcp2_conn_extend_max_stream_offset` extends the maximum stream
4663+ * data that a remote endpoint can send by |datalen|. |stream_id|
4664+ * specifies the stream ID. This function only extends stream-level
4665+ * flow control window.
46544666 *
46554667 * This function returns 0 if it succeeds, or one of the following
46564668 * negative error codes:
0 commit comments