Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2014-11-12 21:52:55 +09:00
parent 24f83eef7c
commit 9416bf9079
1 changed files with 7 additions and 7 deletions

View File

@ -88,9 +88,9 @@ typedef enum {
NGHTTP2_STREAM_FLAG_PUSH = 0x01, NGHTTP2_STREAM_FLAG_PUSH = 0x01,
/* Indicates that this stream was closed */ /* Indicates that this stream was closed */
NGHTTP2_STREAM_FLAG_CLOSED = 0x02, NGHTTP2_STREAM_FLAG_CLOSED = 0x02,
/* Indicates the DATA is deferred due to flow control. */ /* Indicates the item is deferred due to flow control. */
NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL = 0x04, NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL = 0x04,
/* Indicates the DATA is deferred by user callback */ /* Indicates the item is deferred by user callback */
NGHTTP2_STREAM_FLAG_DEFERRED_USER = 0x08, NGHTTP2_STREAM_FLAG_DEFERRED_USER = 0x08,
/* bitwise OR of NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL and /* bitwise OR of NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL and
NGHTTP2_STREAM_FLAG_DEFERRED_USER. */ NGHTTP2_STREAM_FLAG_DEFERRED_USER. */
@ -138,12 +138,12 @@ struct nghttp2_stream {
nghttp2_stream_roots *roots; nghttp2_stream_roots *roots;
/* The arbitrary data provided by user for this stream. */ /* The arbitrary data provided by user for this stream. */
void *stream_user_data; void *stream_user_data;
/* DATA frame item */ /* Item to send */
nghttp2_outbound_item *data_item; nghttp2_outbound_item *data_item;
/* stream ID */ /* stream ID */
int32_t stream_id; int32_t stream_id;
/* categorized priority of this stream. Only stream bearing /* categorized priority of this stream. Only stream bearing
NGHTTP2_STREAM_DPRI_TOP can send DATA frame. */ NGHTTP2_STREAM_DPRI_TOP can send item. */
nghttp2_stream_dpri dpri; nghttp2_stream_dpri dpri;
/* the number of streams in subtree */ /* the number of streams in subtree */
size_t num_substreams; size_t num_substreams;
@ -206,9 +206,9 @@ void nghttp2_stream_free(nghttp2_stream *stream);
void nghttp2_stream_shutdown(nghttp2_stream *stream, nghttp2_shut_flag flag); void nghttp2_stream_shutdown(nghttp2_stream *stream, nghttp2_shut_flag flag);
/* /*
* Defer DATA frame |stream->data_item|. We won't call this function * Defer |stream->data_item|. We won't call this function in the
* in the situation where |stream->data_item| == NULL. If |flags| is * situation where |stream->data_item| == NULL. If |flags| is bitwise
* bitwise OR of zero or more of NGHTTP2_STREAM_FLAG_DEFERRED_USER and * OR of zero or more of NGHTTP2_STREAM_FLAG_DEFERRED_USER and
* NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL. The |flags| indicates * NGHTTP2_STREAM_FLAG_DEFERRED_FLOW_CONTROL. The |flags| indicates
* the reason of this action. * the reason of this action.
* *