Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
N
nghttp2
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
nghttp2
Commits
b9f602b9
Commit
b9f602b9
authored
Apr 23, 2015
by
Tatsuhiro Tsujikawa
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update doc
parent
1a99bcc8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
28 deletions
+31
-28
lib/includes/nghttp2/nghttp2.h
lib/includes/nghttp2/nghttp2.h
+31
-28
No files found.
lib/includes/nghttp2/nghttp2.h
View file @
b9f602b9
...
...
@@ -241,8 +241,9 @@ typedef enum {
*/
NGHTTP2_ERR_UNSUPPORTED_VERSION
=
-
503
,
/**
* Used as a return value from :type:`nghttp2_send_callback` and
* :type:`nghttp2_recv_callback` to indicate that the operation
* Used as a return value from :type:`nghttp2_send_callback`,
* :type:`nghttp2_recv_callback` and
* :type:`nghttp2_send_data_callback` to indicate that the operation
* would block.
*/
NGHTTP2_ERR_WOULDBLOCK
=
-
504
,
...
...
@@ -1275,10 +1276,10 @@ typedef ssize_t (*nghttp2_recv_callback)(nghttp2_session *session, uint8_t *buf,
/**
* @functypedef
*
* Callback function invoked by `nghttp2_session_recv()`
when a frame
*
is received. The |user_data| pointer is the third argument passed
*
in to the call to `nghttp2_session_client_new()` or
* `nghttp2_session_server_new()`.
* Callback function invoked by `nghttp2_session_recv()`
and
*
`nghttp2_session_mem_recv()` when a frame is received. The
*
|user_data| pointer is the third argument passed in to the call to
* `nghttp2_session_
client_new()` or `nghttp2_session_
server_new()`.
*
* If frame is HEADERS or PUSH_PROMISE, the ``nva`` and ``nvlen``
* member of their data structure are always ``NULL`` and 0
...
...
@@ -1313,14 +1314,14 @@ typedef int (*nghttp2_on_frame_recv_callback)(nghttp2_session *session,
/**
* @functypedef
*
* Callback function invoked by `nghttp2_session_recv()`
when an
*
invalid non-DATA frame is received. The |error_code| indicates the
*
error. It is usually one of the :enum:`nghttp2_error_code` but
*
that is not guaranteed. When this callback function is invoked,
* th
e library automatically submits either RST_STREAM or GOAWAY
*
frame. The |user_data| pointer is the third argument passed in to
*
the call to `nghttp2_session_client_new()` or
* `nghttp2_session_server_new()`.
* Callback function invoked by `nghttp2_session_recv()`
and
*
`nghttp2_session_mem_recv()` when an invalid non-DATA frame is
*
received. The |error_code| indicates the error. It is usually one
*
of the :enum:`nghttp2_error_code` but that is not guaranteed. When
* th
is callback function is invoked, the library automatically
*
submits either RST_STREAM or GOAWAY frame. The |user_data| pointer
*
is the third argument passed in to the call to
* `nghttp2_session_
client_new()` or `nghttp2_session_
server_new()`.
*
* If frame is HEADERS or PUSH_PROMISE, the ``nva`` and ``nvlen``
* member of their data structure are always ``NULL`` and 0
...
...
@@ -1328,7 +1329,7 @@ typedef int (*nghttp2_on_frame_recv_callback)(nghttp2_session *session,
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* `nghttp2_session_recv()` and `nghttp2_session_
send
()` functions
* `nghttp2_session_recv()` and `nghttp2_session_
mem_recv
()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* To set this callback to :type:`nghttp2_session_callbacks`, use
...
...
@@ -1361,7 +1362,7 @@ typedef int (*nghttp2_on_invalid_frame_recv_callback)(
* region included in the input bytes.
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* If nonzero is returned, it is treated as fatal error
,
and
* `nghttp2_session_recv()` and `nghttp2_session_mem_recv()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
...
...
@@ -1384,7 +1385,7 @@ typedef int (*nghttp2_on_data_chunk_recv_callback)(nghttp2_session *session,
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* `nghttp2_session_
recv()` and `nghttp2_session
_send()` functions
* `nghttp2_session_
send()` and `nghttp2_session_mem
_send()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* To set this callback to :type:`nghttp2_session_callbacks`, use
...
...
@@ -1403,7 +1404,7 @@ typedef int (*nghttp2_before_frame_send_callback)(nghttp2_session *session,
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* `nghttp2_session_
recv()` and `nghttp2_session
_send()` functions
* `nghttp2_session_
send()` and `nghttp2_session_mem
_send()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* To set this callback to :type:`nghttp2_session_callbacks`, use
...
...
@@ -1425,7 +1426,7 @@ typedef int (*nghttp2_on_frame_send_callback)(nghttp2_session *session,
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* `nghttp2_session_
recv()` and `nghttp2_session
_send()` functions
* `nghttp2_session_
send()` and `nghttp2_session_mem
_send()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* `nghttp2_session_get_stream_user_data()` can be used to get
...
...
@@ -1455,8 +1456,9 @@ typedef int (*nghttp2_on_frame_not_send_callback)(nghttp2_session *session,
*
* The implementation of this function must return 0 if it succeeds.
* If nonzero is returned, it is treated as fatal error and
* `nghttp2_session_recv()` and `nghttp2_session_send()` functions
* immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
* `nghttp2_session_recv()`, `nghttp2_session_mem_recv()`,
* `nghttp2_session_send()`, and `nghttp2_session_mem_send()`
* functions immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* To set this callback to :type:`nghttp2_session_callbacks`, use
* `nghttp2_session_callbacks_set_on_stream_close_callback()`.
...
...
@@ -1498,7 +1500,7 @@ typedef int (*nghttp2_on_stream_close_callback)(nghttp2_session *session,
* frame with ``frame->headers.cat == NGHTTP2_HCAT_HEADERS``
* containing final response headers (non-1xx status code). The
* trailer headers also has ``frame->headers.cat ==
* NGHTTP2_HCAT_HEADERS`` which does not contain
g
any status code.
* NGHTTP2_HCAT_HEADERS`` which does not contain any status code.
*
* The implementation of this function must return 0 if it succeeds or
* :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`. If nonzero value other than
...
...
@@ -1596,8 +1598,8 @@ typedef int (*nghttp2_on_header_callback)(nghttp2_session *session,
* :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`. Returning
* ``frame->hd.length`` means no padding is added. Returning
* :enum:`NGHTTP2_ERR_CALLBACK_FAILURE` will make
* `nghttp2_session_send()`
function immediately return
* :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
* `nghttp2_session_send()`
and `nghttp2_session_mem_send()` functions
*
immediately return
:enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
*
* To set this callback to :type:`nghttp2_session_callbacks`, use
* `nghttp2_session_callbacks_set_select_padding_callback()`.
...
...
@@ -1726,8 +1728,8 @@ NGHTTP2_EXTERN void nghttp2_session_callbacks_set_recv_callback(
/**
* @function
*
* Sets callback function invoked by `nghttp2_session_recv()`
when a
* frame is received.
* Sets callback function invoked by `nghttp2_session_recv()`
and
*
`nghttp2_session_mem_recv()` when a
frame is received.
*/
NGHTTP2_EXTERN
void
nghttp2_session_callbacks_set_on_frame_recv_callback
(
nghttp2_session_callbacks
*
cbs
,
...
...
@@ -1736,8 +1738,9 @@ NGHTTP2_EXTERN void nghttp2_session_callbacks_set_on_frame_recv_callback(
/**
* @function
*
* Sets callback function invoked by `nghttp2_session_recv()` when an
* invalid non-DATA frame is received.
* Sets callback function invoked by `nghttp2_session_recv()` and
* `nghttp2_session_mem_recv()` when an invalid non-DATA frame is
* received.
*/
NGHTTP2_EXTERN
void
nghttp2_session_callbacks_set_on_invalid_frame_recv_callback
(
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment