nghttp2/nghttp2
1
0
Fork 0
mirror of https://github.com/nghttp2/nghttp2.git synced 2025-12-09 19:48:53 +08:00
Code Issues Projects Releases Wiki Activity

nghttp2_data_source_read_callback: Replace eof with uint32_t *data_flags

Browse Source 
Replace int *eof with uint32_t *data_flags so that we can easily
extend functionality if we have to (but we don't do if possible).
This commit is contained in:
Tatsuhiro Tsujikawa
2014-04-05 17:59:24 +09:00
parent a0d93e7744
commit e7ad3633c7
8 changed files with 52 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
lib/includes/nghttp2/nghttp2.h
View File

@@ -621,6 +621,23 @@ typedef union {
void *ptr;
} nghttp2_data_source;
/**
* @enum
*
* The flags used to set in |data_flags| output parameter in
* :type:`nghttp2_data_source_read_callback`.
*/
typedef enum {
/**
* No flag set.
*/
NGHTTP2_DATA_FLAG_NONE = 0,
/**
* Indicates EOF was sensed.
*/
NGHTTP2_DATA_FLAG_EOF = 0x01
} nghttp2_data_flag;
/**
* @functypedef
*
@@ -629,21 +646,22 @@ typedef union {
* implementation of this function must read at most |length| bytes of
* data from |source| (or possibly other places) and store them in
* |buf| and return number of data stored in |buf|. If EOF is reached,
* set |*eof| to 1. If the application wants to postpone DATA frames,
* (e.g., asynchronous I/O, or reading data blocks for long time), it
* is achieved by returning :enum:`NGHTTP2_ERR_DEFERRED` without
* reading any data in this invocation. The library removes DATA
* frame from the outgoing queue temporarily. To move back deferred
* DATA frame to outgoing queue, call `nghttp2_session_resume_data()`.
* In case of error, there are 2 choices. Returning
* :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` will close the stream
* by issuing RST_STREAM with :enum:`NGHTTP2_INTERNAL_ERROR`.
* Returning :enum:`NGHTTP2_ERR_CALLBACK_FAILURE` will signal the
* entire session failure.
* set :enum:`NGHTTP2_DATA_FLAG_EOF` flag in |*data_falgs|. If the
* application wants to postpone DATA frames, (e.g., asynchronous I/O,
* or reading data blocks for long time), it is achieved by returning
* :enum:`NGHTTP2_ERR_DEFERRED` without reading any data in this
* invocation. The library removes DATA frame from the outgoing queue
* temporarily. To move back deferred DATA frame to outgoing queue,
* call `nghttp2_session_resume_data()`. In case of error, there are
* 2 choices. Returning :enum:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE`
* will close the stream by issuing RST_STREAM with
* :enum:`NGHTTP2_INTERNAL_ERROR`. Returning
* :enum:`NGHTTP2_ERR_CALLBACK_FAILURE` will signal the entire session
* failure.
*/
typedef ssize_t (*nghttp2_data_source_read_callback)
(nghttp2_session *session, int32_t stream_id,
uint8_t *buf, size_t length, int *eof,
uint8_t *buf, size_t length, uint32_t *data_flags,
nghttp2_data_source *source, void *user_data);
/**