' + _('Hide Search Matches') + '
') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/released-versions/v0.2.0/_static/down-pressed.png b/released-versions/v0.2.0/_static/down-pressed.png new file mode 100644 index 00000000..6f7ad782 Binary files /dev/null and b/released-versions/v0.2.0/_static/down-pressed.png differ diff --git a/released-versions/v0.2.0/_static/down.png b/released-versions/v0.2.0/_static/down.png new file mode 100644 index 00000000..3003a887 Binary files /dev/null and b/released-versions/v0.2.0/_static/down.png differ diff --git a/released-versions/v0.2.0/_static/file.png b/released-versions/v0.2.0/_static/file.png new file mode 100644 index 00000000..d18082e3 Binary files /dev/null and b/released-versions/v0.2.0/_static/file.png differ diff --git a/released-versions/v0.2.0/_static/jquery.js b/released-versions/v0.2.0/_static/jquery.js new file mode 100644 index 00000000..12581195 --- /dev/null +++ b/released-versions/v0.2.0/_static/jquery.js @@ -0,0 +1,9404 @@ +/*! + * jQuery JavaScript Library v1.7.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Thu Aug 1 23:20:30 BRT 2013 + */ +(function( window, undefined ) { + +// Use the correct document accordingly with window argument (sandbox) +var document = window.document, + navigator = window.navigator, + location = window.location; +var jQuery = (function() { + +// Define a local copy of jQuery +var jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + return new jQuery.fn.init( selector, context, rootjQuery ); + }, + + // Map over jQuery in case of overwrite + _jQuery = window.jQuery, + + // Map over the $ in case of overwrite + _$ = window.$, + + // A central reference to the root jQuery(document) + rootjQuery, + + // A simple way to check for HTML strings or ID strings + // Prioritize #id over| t |
To use the public APIs, include nghttp2/nghttp2.h:
+#include <nghttp2/nghttp2.h>
+The header files are also available online: nghttp2.h and +nghttp2ver.h.
+Do not call nghttp2_session_send(), nghttp2_session_recv() or +nghttp2_session_mem_recv() from the nghttp2 callback functions +directly or indirectly. It will lead to the crash. You can submit +requests or frames in the callbacks then call nghttp2_session_send(), +nghttp2_session_recv() or nghttp2_session_mem_recv() outside of the +callbacks.
+Version number of the nghttp2 library release
+Numerical representation of the version number of the nghttp2 library +release. This is a 24 bit number with 8 bits for major number, 8 bits +for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.
+The protocol version identification of this library supports.
+The length of NGHTTP2_PROTO_VERSION_ID.
+The age of nghttp2_info
+The default priority value
+The lowest priority value
+The maximum window size
+The initial window size for stream level flow control.
+The initial window size for connection level flow control.
+The maximum header table size.
+The client connection header.
+The length of NGHTTP2_CLIENT_CONNECTION_HEADER.
+Default maximum concurrent streams.
+Error codes used in this library. The code range is [-999, -500], +inclusive. The following values are defined:
+(-501) +Invalid argument passed.
+(-503) +The specified protocol version is not supported.
+(-504) +Used as a return value from nghttp2_send_callback and +nghttp2_recv_callback to indicate that the operation +would block.
+(-505) +General protocol error
+(-506) +The frame is invalid.
+(-507) +The peer performed a shutdown on the connection.
+(-508) +Used as a return value from +nghttp2_data_source_read_callback() to indicate that data +transfer is postponed. See +nghttp2_data_source_read_callback() for details.
+(-509) +Stream ID has reached the maximum value. Therefore no stream ID +is available.
+(-510) +The stream is already closed; or the stream ID is invalid.
+(-511) +RST_STREAM has been added to the outbound queue. The stream is in +closing state.
+(-512) +The transmission is not allowed for this stream (e.g., a frame +with END_STREAM flag set has already sent).
+(-513) +The stream ID is invalid.
+(-514) +The state of the stream is not valid (e.g., DATA cannot be sent +to the stream if response HEADERS has not been sent).
+(-515) +Another DATA frame has already been deferred.
+(-516) +Starting new stream is not allowed. (e.g., GOAWAY has been sent +and/or received.
+(-517) +GOAWAY has already been sent.
+(-518) +The received frame contains the invalid header block. (e.g., +There are duplicate header names; or the header names are not +encoded in US-ASCII character set and not lower cased; or the +header name is zero-length string; or the header value contains +multiple in-sequence NUL bytes).
+(-519) +Indicates that the context is not suitable to perform the +requested operation.
+(-520) +The gzip error.
+(-521) +The user callback function failed due to the temporal error.
+(-522) +The length of the frame is invalid, either too large or too small.
+(-523) +Header block inflate/deflate error.
+(-524) +Flow control error
+(-525) +Insufficient buffer size given to function.
+(-526) +Callback was paused by the application
+(-527) +There are too many in-flight SETTING frame and no more +transmission of SETTINGS is allowed.
+(-528) +The server push is disabled.
+(-900) +The errors < NGHTTP2_ERR_FATAL mean that the library is +under unexpected condition and cannot process any further data +reliably (e.g., out of memory).
+(-901) +Out of memory. This is a fatal error.
+(-902) +The user callback function failed. This is a fatal error.
+The control frame types in HTTP/2.0.
+(0) +The DATA frame.
+(1) +The HEADERS frame.
+(2) +The PRIORITY frame.
+(3) +The RST_STREAM frame.
+(4) +The SETTINGS frame.
+(5) +The PUSH_PROMISE frame.
+(6) +The PING frame.
+(7) +The GOAWAY frame.
+(9) +The WINDOW_UPDATE frame.
+The flags for HTTP/2.0 frames. This enum defines all flags for +frames, assuming that the same flag name has the same mask.
+(0) +No flag set.
+(0x1) +The END_STREAM flag.
+(0x4) +The END_HEADERS flag.
+(0x8) +The PRIORITY flag.
+(0x4) +The END_PUSH_PROMISE flag.
+(0x1) +The ACK flag.
+The SETTINGS ID.
+(1) +SETTINGS_HEADER_TABLE_SIZE
+(2) +SETTINGS_ENABLE_PUSH
+(4) +SETTINGS_MAX_CONCURRENT_STREAMS
+(7) +SETTINGS_INITIAL_WINDOW_SIZE
+(10) +SETTINGS_FLOW_CONTROL_OPTIONS
+(10) +Maximum ID of nghttp2_settings_id.
+The status codes for the RST_STREAM and GOAWAY frames.
+(0) +No errors.
+(1) +PROTOCOL_ERROR
+(2) +INTERNAL_ERROR
+(3) +FLOW_CONTROL_ERROR
+(4) +SETTINGS_TIMEOUT
+(5) +STREAM_CLOSED
+(6) +FRAME_SIZE_ERROR
+(7) +REFUSED_STREAM
+(8) +CANCEL
+(9) +COMPRESSION_ERROR
+(10) +CONNECT_ERROR
+(420) +ENHANCE_YOUR_CALM
+The category of HEADERS, which indicates the role of the frame. In +HTTP/2.0 spec, request, response, push response and other arbitrary +headers (e.g., trailers) are all called just HEADERS. To give the +application the role of incoming HEADERS frame, we define several +categories.
+(0) +The HEADERS frame is opening new stream, which is analogous to +SYN_STREAM in SPDY.
+(1) +The HEADERS frame is the first response headers, which is +analogous to SYN_REPLY in SPDY.
+(2) +The HEADERS frame is the first headers sent against reserved +stream.
+(3) +The HEADERS frame which does not apply for the above categories, +which is analogous to HEADERS in SPDY.
+Configuration options for nghttp2_session.
+(1) +This option prevents the library from sending WINDOW_UPDATE for a +stream automatically. If this option is set, the application is +responsible for sending WINDOW_UPDATE using +nghttp2_submit_window_update().
+(2) +This option prevents the library from sending WINDOW_UPDATE for a +connection automatically. If this option is set, the application +is responsible for sending WINDOW_UPDATE with stream ID 0 using +nghttp2_submit_window_update().
+(3) +This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of +remote endpoint as if it is received in SETTINGS frame. Without +specifying this option, before the local endpoint receives +SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote +endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may +cause problem if local endpoint submits lots of requests +initially and sending them at once to the remote peer may lead to +the rejection of some requests. Specifying this option to the +sensible value, say 100, may avoid this kind of issue. This value +will be overwritten if the local endpoint receives +SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.
+The primary structure to hold the resources needed for a HTTP/2.0 +session. The details of this structure are intentionally hidden +from the public API.
+This struct is what nghttp2_version() returns. It holds +information about the particular nghttp2 version.
+Age of this struct. This instance of nghttp2 sets it to +NGHTTP2_VERSION_AGE but a future version may bump it and +add more struct fields at the bottom
+the NGHTTP2_VERSION_NUM number (since age ==1)
+points to the NGHTTP2_VERSION string (since age ==1)
+points to the NGHTTP2_PROTO_VERSION_ID string this +instance implements (since age ==1)
+The name/value pair, which mainly used to represent header fields.
+The name byte string, which is not necessarily NULL +terminated.
+The value byte string, which is not necessarily NULL +terminated.
+The length of the name.
+The length of the value.
+The frame header.
+The length field of this frame, excluding frame header.
+The type of this frame. See nghttp2_frame().
+The flags.
+The stream identifier (aka, stream ID)
+This union represents the some kind of data source passed to +nghttp2_data_source_read_callback.
+The integer field, suitable for a file descriptor.
+The pointer to an arbitrary object.
+Callback function invoked when the library wants to read data from +the source. The read data is sent in the stream stream_id. The +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 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 +NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE will close the stream +by issuing RST_STREAM with NGHTTP2_INTERNAL_ERROR. +Returning NGHTTP2_ERR_CALLBACK_FAILURE will signal the +entire session failure.
+This struct represents the data source and the way to read a chunk +of data from it.
+The data source.
+The callback function to read a chunk of data from the source.
+The HEADERS frame. It has the following members:
+The frame header.
+The priority.
+The name/value pairs.
+The number of name/value pairs in nva.
+The PRIORITY frame. It has the following members:
+The frame header.
+The priority.
+The RST_STREAM frame. It has the following members:
+The frame header.
+The error code. See nghttp2_error_code.
+The SETTINGS ID/Value pair. It has the following members:
+The SETTINGS ID. See nghttp2_settings_id.
+The value of this entry.
+The SETTINGS frame. It has the following members:
+The frame header.
+The number of SETTINGS ID/Value pairs in iv.
+The pointer to the array of SETTINGS ID/Value pair.
+The PUSH_PROMISE frame. It has the following members:
+The frame header.
+The promised stream ID
+The name/value pairs.
+The number of name/value pairs in nva.
+The PING frame. It has the following members:
+The frame header.
+The opaque data
+The GOAWAY frame. It has the following members:
+The frame header.
+The last stream stream ID.
+The error code. See nghttp2_error_code.
+The additional debug data
+The length of opaque_data member.
+The WINDOW_UPDATE frame. It has the following members:
+The frame header.
+The window size increment.
+This union includes all frames to pass them to various function +calls as nghttp2_frame type. The DATA frame is intentionally +omitted from here.
+The frame header, which is convenient to inspect frame header.
+The HEADERS frame.
+The PRIORITY frame.
+The RST_STREAM frame.
+The SETTINGS frame.
+The PUSH_PROMISE frame.
+The PING frame.
+The GOAWAY frame.
+The WINDOW_UPDATE frame.
+Callback function invoked when session wants to send data to the +remote peer. The implementation of this function must send at most +length bytes of data stored in data. The flags is currently +not used and always 0. It must return the number of bytes sent if +it succeeds. If it cannot send any single byte without blocking, +it must return NGHTTP2_ERR_WOULDBLOCK. For other errors, it +must return NGHTTP2_ERR_CALLBACK_FAILURE. 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 when session wants to receive data from +the remote peer. The implementation of this function must read at +most length bytes of data and store it in buf. The flags is +currently not used and always 0. It must return the number of bytes +written in buf if it succeeds. If it cannot read any single byte +without blocking, it must return NGHTTP2_ERR_WOULDBLOCK. If +it gets EOF before it reads any single byte, it must return +NGHTTP2_ERR_EOF. For other errors, it must return +NGHTTP2_ERR_CALLBACK_FAILURE. Returning 0 is treated as +NGHTTP2_ERR_WOULDBLOCK. 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() when a +non-DATA 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 the application uses nghttp2_session_mem_recv(), it can return +NGHTTP2_ERR_PAUSE to make nghttp2_session_mem_recv() +return without processing further input bytes. The frame +parameter is retained until nghttp2_session_continue() is +called. The application must retain the input bytes which was used +to produce the frame parameter, because it may refer to the +memory region included in the input bytes. The application which +returns NGHTTP2_ERR_PAUSE must call +nghttp2_session_continue() before nghttp2_session_mem_recv().
+The implementation of this function must return 0 if it +succeeds. It may return NGHTTP2_ERR_PAUSE. If the other +nonzero value is returned, it is treated as fatal error and +nghttp2_session_recv() and nghttp2_session_send() functions +immediately return NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked by nghttp2_session_recv() when an +invalid non-DATA frame is received. The error_code is one of the +nghttp2_error_code and indicates the error. When this +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().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when a chunk of data in DATA frame is +received. The stream_id is the stream ID this DATA frame belongs +to. The flags is the flags of DATA frame which this data chunk is +contained. (flags & NGHTTP2_FLAG_END_STREAM) != 0 does not +necessarily mean this chunk of data is the last one in the +stream. You should use nghttp2_on_data_recv_callback to +know all data frames are 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 the application uses nghttp2_session_mem_recv(), it can return +NGHTTP2_ERR_PAUSE to make nghttp2_session_mem_recv() +return without processing further input bytes. The frame +parameter is retained until nghttp2_session_continue() is +called. The application must retain the input bytes which was used +to produce the frame parameter, because it may refer to the +memory region included in the input bytes. The application which +returns NGHTTP2_ERR_PAUSE must call +nghttp2_session_continue() before nghttp2_session_mem_recv().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when DATA frame is received. The actual +data it contains are received by +nghttp2_on_data_chunk_recv_callback. The user_data +pointer is the third argument passed in to the call to +nghttp2_session_client_new() or nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked before the non-DATA frame frame is +sent. This may be useful, for example, to know the stream ID of +HEADERS and PUSH_PROMISE frame (see also +nghttp2_session_get_stream_user_data()), which is not assigned +when it was queued. The user_data pointer is the third argument +passed in to the call to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked after the non-DATA frame frame is sent. +The user_data pointer is the third argument passed in to the call +to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked after the non-DATA frame frame is not +sent because of the error. The error is indicated by the +lib_error_code, which is one of the values defined in +nghttp2_error. The user_data pointer is the third +argument passed in to the call to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked after DATA frame is sent. The user_data +pointer is the third argument passed in to the call to +nghttp2_session_client_new() or nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when the stream stream_id is +closed. The reason of closure is indicated by the error_code. The +stream_user_data, which was specified in nghttp2_submit_request() +or nghttp2_submit_headers(), is still available in this +function. The user_data pointer is the third argument passed in +to the call to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when the request from the remote peer is +received. In other words, the frame with END_STREAM flag set is +received. In HTTP, this means HTTP request, including request +body, is fully received. The user_data pointer is the third +argument passed in to the call to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when the received control frame octets +could not be parsed correctly. The type indicates the type of +received non-DATA frame. The head is the pointer to the header of +the received frame. The headlen is the length of the +head. According to the spec, the headlen is always 8. In other +words, the head is the first 8 bytes of the received frame. The +payload is the pointer to the data portion of the received frame. +The payloadlen is the length of the payload. This is the data +after the length field. The lib_error_code is one of the error +code defined in nghttp2_error and indicates the error. The +user_data pointer is the third argument passed in to the call to +nghttp2_session_client_new() or nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback function invoked when the received frame type is +unknown. The head is the pointer to the header of the received +frame. The headlen is the length of the head. According to the +spec, the headlen is always 8. In other words, the head is the +first 8 bytes of the received frame. The payload is the pointer +to the data portion of the received frame. The payloadlen is the +length of the payload. This is the data after the length +field. The user_data pointer is the third argument passed in to +the call to nghttp2_session_client_new() or +nghttp2_session_server_new().
+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 NGHTTP2_ERR_CALLBACK_FAILURE.
+Callback functions.
+Callback function invoked when the session wants to send data +to the remote peer.
+Callback function invoked when the session wants to receive +data from the remote peer.
+Callback function invoked by nghttp2_session_recv() when a +non-DATA frame is received.
+Callback function invoked by nghttp2_session_recv() when an +invalid non-DATA frame is received.
+Callback function invoked when a chunk of data in DATA frame is +received.
+Callback function invoked when DATA frame is received.
+Callback function invoked before the non-DATA frame is sent.
+Callback function invoked after the non-DATA frame is sent.
+The callback function invoked when a non-DATA frame is not sent +because of an error.
+Callback function invoked after DATA frame is sent.
+Callback function invoked when the stream is closed.
+Callback function invoked when request from the remote peer is +received.
+Callback function invoked when the received non-DATA frame octets +could not be parsed correctly.
+Callback function invoked when the received frame type is +unknown.
+The gzip stream to inflate data. The details of this structure are +intentionally hidden from the public API.
+Initializes *session_ptr for client use. The all members of +callbacks are copied to *session_ptr. Therefore *session_ptr +does not store callbacks. user_data is an arbitrary user +supplied data, which will be passed to the callback functions.
+The nghttp2_session_callbacks.send_callback must be +specified. If the application code uses nghttp2_session_recv(), +the nghttp2_session_callbacks.recv_callback must be +specified. The other members of callbacks can be NULL.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Initializes *session_ptr for server use. The all members of +callbacks are copied to *session_ptr. Therefore *session_ptr +does not store callbacks. user_data is an arbitrary user +supplied data, which will be passed to the callback functions.
+The nghttp2_session_callbacks.send_callback must be +specified. If the application code uses nghttp2_session_recv(), +the nghttp2_session_callbacks.recv_callback must be +specified. The other members of callbacks can be NULL.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Frees any resources allocated for session. If session is +NULL, this function does nothing.
+Sets the configuration option for the session. The optname is +one of nghttp2_opt. The optval is the pointer to the +option value and the optlen is the size of *optval. The +required type of optval varies depending on the optname. See +below.
+The following optname are supported:
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Sends pending frames to the remote peer.
+This function retrieves the highest prioritized frame from the +outbound queue and sends it to the remote peer. It does this as +many as possible until the user callback +nghttp2_session_callbacks.send_callback returns +NGHTTP2_ERR_WOULDBLOCK or the outbound queue becomes empty. +This function calls several callback functions which are passed +when initializing the session. Here is the simple time chart +which tells when each callback is invoked:
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Receives frames from the remote peer.
+This function receives as many frames as possible until the user +callback nghttp2_session_callbacks.recv_callback returns +NGHTTP2_ERR_WOULDBLOCK. This function calls several +callback functions which are passed when initializing the +session. Here is the simple time chart which tells when each +callback is invoked:
++++
+- 2.1. nghttp2_session_callbacks.recv_callback is invoked
+- to receive DATA payload. For each chunk of data, +nghttp2_session_callbacks.on_data_chunk_recv_callback +is invoked.
+- 2.2. If one DATA frame is completely received,
+- nghttp2_session_callbacks.on_data_recv_callback is +invoked. If the frame is the final frame of the request, +nghttp2_session_callbacks.on_request_recv_callback +is invoked. If the reception of the frame triggers the +closure of the stream, +nghttp2_session_callbacks.on_stream_close_callback +is invoked.
+
+++
+- 3.1. nghttp2_session_callbacks.recv_callback is invoked
+- one or more times to receive whole frame.
+- 3.2. If the received frame is valid,
+- nghttp2_session_callbacks.on_ctrl_recv_callback is +invoked. If the frame is the final frame of the request, +nghttp2_session_callbacks.on_request_recv_callback +is invoked. If the reception of the frame triggers the +closure of the stream, +nghttp2_session_callbacks.on_stream_close_callback +is invoked.
+- 3.3. If the received frame is unpacked but is interpreted as
+- invalid, +nghttp2_session_callbacks.on_invalid_ctrl_recv_callback +is invoked.
+- 3.4. If the received frame could not be unpacked correctly,
+- nghttp2_session_callbacks.on_ctrl_recv_parse_error_callback +is invoked.
+- 3.5. If the received frame type is unknown,
+- nghttp2_session_callbacks.on_unknown_ctrl_recv_callback +is invoked.
+
This function returns 0 if it succeeds, or one of the following +negative error codes:
+Processes data in as an input from the remote endpoint. The +inlen indicates the number of bytes in the in.
+This function behaves like nghttp2_session_recv() except that it +does not use nghttp2_session_callbacks.recv_callback to +receive data; the in is the only data for the invocation of this +function. If all bytes are processed, this function returns. The +other callbacks are called in the same way as they are in +nghttp2_session_recv().
+In the current implementation, this function always tries to +processes all input data unless either an error occurs or +NGHTTP2_ERR_PAUSE is returned from +nghttp2_session_callbacks.on_frame_recv_callback or +nghttp2_session_callbacks.on_data_chunk_recv_callback. +If NGHTTP2_ERR_PAUSE is used, the return value includes the +number of bytes which was used to produce the data or frame for the +callback.
+This function returns the number of processed bytes, or one of the +following negative error codes:
+Perform post-processing after nghttp2_session_mem_recv() was +paused by NGHTTP2_ERR_PAUSE from +nghttp2_session_callbacks.on_frame_recv_callback or +nghttp2_session_callbacks.on_data_chunk_recv_callback.
+This function frees resources associated with paused frames. It +may also call additional callbacks, such as +nghttp2_session_callbacks.on_stream_close_callback.
+If this function succeeds, the application can call +nghttp2_session_mem_recv() again.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Puts back previously deferred DATA frame in the stream stream_id +to the outbound queue.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Returns nonzero value if session wants to receive data from the +remote peer.
+If both nghttp2_session_want_read() and +nghttp2_session_want_write() return 0, the application should +drop the connection.
+Returns nonzero value if session wants to send data to the remote +peer.
+If both nghttp2_session_want_read() and +nghttp2_session_want_write() return 0, the application should +drop the connection.
+Returns stream_user_data for the stream stream_id. The +stream_user_data is provided by nghttp2_submit_request() or +nghttp2_submit_syn_stream(). If the stream is initiated by the +remote endpoint, stream_user_data is always NULL. If the stream +is initiated by the local endpoint and NULL is given in +nghttp2_submit_request() or nghttp2_submit_syn_stream(), then +this function returns NULL. If the stream does not exist, this +function returns NULL.
+Returns the number of frames in the outbound queue. This does not +include the deferred DATA frames.
+Returns the number of DATA payload in bytes received without +WINDOW_UPDATE transmission for the stream stream_id. The local +(receive) window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective data length. In particular, if the +local window size is reduced by submitting negative +window_size_increment with nghttp2_submit_window_update(), this +function returns the number of bytes less than actually received.
+If flow control is disabled for that stream, this function returns +0.
+This function returns -1 if it fails.
+Returns the local (receive) window size for the stream +stream_id. The local window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective window size.
+This function returns -1 if it fails.
+Returns the number of DATA payload in bytes received without +WINDOW_UPDATE transmission for a connection. The local (receive) +window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective data length. In particular, if the local +window size is reduced by submitting negative window_size_increment +with nghttp2_submit_window_update(), this function returns the +number of bytes less than actually received.
+If flow control is disabled for a connection, this function returns +0.
+This function returns -1 if it fails.
+Returns the local (receive) window size for a connection. The local +window size can be adjusted by +nghttp2_submit_window_update(). This function takes into account +that and returns effective window size.
+This function returns -1 if it fails.
+Submits GOAWAY frame with the given error_code.
+This function should be called when the connection should be +terminated after sending GOAWAY. If the remaining streams should be +processed after GOAWAY, use nghttp2_submit_goaway() instead.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Performs post-process of HTTP Upgrade request. This function can be +called from both client and server, but the behavior is very +different in each other.
+If called from client side, the settings_payload must be the +value sent in HTTP2-Settings header field and must be decoded +by base64url decoder. The settings_payloadlen is the length of +settings_payload. The settings_payload is unpacked and its +setting values will be submitted using +nghttp2_submit_settings(). This means that the client application +code does not need to submit SETTINGS by itself. The stream with +stream ID=1 is opened and the stream_user_data is used for its +stream_user_data. The opened stream becomes half-closed (local) +state.
+If called from server side, the settings_payload must be the +value received in HTTP2-Settings header field and must be +decoded by base64url decoder. The settings_payloadlen is the +length of settings_payload. It is treated as if the SETTINGS +frame with that payload is received. Thus, callback functions for +the reception of SETTINGS frame will be invoked. The stream with +stream ID=1 is opened. The stream_user_data is ignored. The +opened stream becomes half-closed (remote).
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Serializes the SETTINGS values iv in the buf. The size of the +buf is specified by buflen. The number of entries in the iv +array is given by niv. The required space in buf for the niv +entries is 8*niv bytes and if the given buffer is too small, an +error is returned. This function is used mainly for creating a +SETTINGS payload to be sent with the HTTP2-Settings header +field in an HTTP Upgrade request. The data written in buf is NOT +base64url encoded and the application is responsible for encoding.
+This function returns the number of bytes written in buf, or one +of the following negative error codes:
+Returns string describing the lib_error_code. The +lib_error_code must be one of the nghttp2_error.
+Submits HEADERS frame and optionally one or more DATA frames.
+The pri is priority of this request. 0 is the highest priority +value and NGHTTP2_PRI_LOWEST is the lowest value.
+The nv contains the name/value pairs. For i >= 0, nv[2*i] +contains a pointer to the name string and nv[2*i+1] contains a +pointer to the value string. The one beyond last value must be +NULL. That is, if the nv contains N name/value pairs, +nv[2*N] must be NULL.
+HTTP/2.0 specification has requirement about header fields in the +request HEADERS. See the specification for more details.
+This function creates copies of all name/value pairs in nv. It +also lower-cases all names in nv.
+The string in nv must be NULL-terminated. Use +nghttp2_submit_request2() if name/value pairs are not +NULL-terminated strings.
+If data_prd is not NULL, it provides data which will be sent +in subsequent DATA frames. In this case, a method that allows +request message bodies +(http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9) must +be specified with :method key in nv (e.g. POST). This +function does not take ownership of the data_prd. The function +copies the members of the data_prd. If data_prd is NULL, +HEADERS have END_STREAM set. The stream_user_data is data +associated to the stream opened by this request and can be an +arbitrary pointer, which can be retrieved later by +nghttp2_session_get_stream_user_data().
+Since the library reorders the frames and tries to send the highest +prioritized one first and the HTTP/2.0 specification requires the +stream ID must be strictly increasing, the stream ID of this +request cannot be known until it is about to sent. To know the +stream ID of the request, the application can use +nghttp2_session_callbacks.before_ctrl_send_callback. This +callback is called just before the frame is sent. For HEADERS +frame, the argument frame has the stream ID assigned. Also since +the stream is already opened, +nghttp2_session_get_stream_user_data() can be used to get +stream_user_data to identify which HEADERS we are processing.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Just like nghttp2_submit_request(), but this function takes the +nva, which is an array of nghttp2_nv with nvlen elements, +as name/value pairs. This function is useful if name/value pairs +are not NULL-terminated strings.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits response HEADERS frame and optionally one or more DATA +frames against the stream stream_id.
+The nv contains the name/value pairs. For i >= 0, nv[2*i] +contains a pointer to the name string and nv[2*i+1] contains a +pointer to the value string. The one beyond last value must be +NULL. That is, if the nv contains N name/value pairs, +nv[2*N] must be NULL.
+HTTP/2.0 specification has requirement about header fields in the +response HEADERS. See the specification for more details.
+This function creates copies of all name/value pairs in nv. It +also lower-cases all names in nv.
+If data_prd is not NULL, it provides data which will be sent +in subsequent DATA frames. This function does not take ownership +of the data_prd. The function copies the members of the +data_prd. If data_prd is NULL, HEADERS will have +END_STREAM flag set.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits HEADERS frame. The flags is bitwise OR of the +following values:
+ +If flags includes NGHTTP2_FLAG_END_STREAM, this frame has +END_STREAM flag set. The library does not support header +continuation and the HEADERS frame always has +NGHTTP2_FLAG_END_HEADERS flag set regardless of the flags +value.
+If the stream_id is -1, this frame is assumed as request (i.e., +request HEADERS frame which opens new stream). In this case, the +actual stream ID is assigned just before the frame is sent. For +response, specify stream ID in stream_id.
+The pri is priority of this request.
+The nv contains the name/value pairs. For i >= 0, nv[2*i] +contains a pointer to the name string and nv[2*i+1] contains a +pointer to the value string. The one beyond last value must be +NULL. That is, if the nv contains N name/value pairs, +nv[2*N] must be NULL.
+This function creates copies of all name/value pairs in nv. It +also lower-cases all names in nv.
+The stream_user_data is a pointer to an arbitrary data which is +associated to the stream this frame will open. Therefore it is only +used if this frame opens streams, in other words, it changes stream +state from idle or reserved to open.
+This function is low-level in a sense that the application code can +specify flags directly. For usual HTTP request, +nghttp2_submit_request() is useful.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits one or more DATA frames to the stream stream_id. The +data to be sent are provided by data_prd. If flags contains +NGHTTP2_FLAG_END_STREAM, the last DATA frame has END_STREAM +flag set.
+This function does not take ownership of the data_prd. The +function copies the members of the data_prd.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits PRIORITY frame to change the priority of stream stream_id +to the priority value pri.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits RST_STREAM frame to cancel/reject the stream stream_id +with the error code error_code.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Stores local settings and submits SETTINGS frame. The iv is the +pointer to the array of nghttp2_settings_entry. The niv +indicates the number of nghttp2_settings_entry.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+This function does not take ownership of the iv. This function +copies all the elements in the iv.
+While updating individual stream’s local window size, if the window +size becomes strictly larger than NGHTTP2_MAX_WINDOW_SIZE, +RST_STREAM is issued against such a stream.
+SETTINGS with NGHTTP2_FLAG_ACK is automatically submitted +by the library and application could not send it at its will.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits PUSH_PROMISE frame. The flags is currently ignored and +the resulting PUSH_PROMISE frame always has +NGHTTP2_FLAG_END_PUSH_PROMISE flag set due to the lack of +header continuation support in the library.
+The stream_id must be client initiated stream ID.
+The nv contains the name/value pairs. For i >= 0, nv[2*i] +contains a pointer to the name string and nv[2*i+1] contains a +pointer to the value string. The one beyond last value must be +NULL. That is, if the nv contains N name/value pairs, +nv[2*N] must be NULL.
+This function creates copies of all name/value pairs in nv. It +also lower-cases all names in nv.
+Since the library reorders the frames and tries to send the highest +prioritized one first and the HTTP/2.0 specification requires the +stream ID must be strictly increasing, the promised stream ID +cannot be known until it is about to sent. To know the promised +stream ID, the application can use +nghttp2_session_callbacks.before_frame_send_callback. This +callback is called just before the frame is sent. For PUSH_PROMISE +frame, the argument frame has the promised stream ID assigned.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits PING frame. You don’t have to send PING back when you +received PING frame. The library automatically submits PING frame +in this case.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+If the opaque_data is non NULL, then it should point to the 8 +bytes array of memory to specify opaque data to send with PING +frame. If the opaque_data is NULL, zero-cleared 8 bytes will +be sent as opaque data.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits GOAWAY frame with the error code error_code.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+If the opaque_data is not NULL and opaque_data_len is not +zero, those data will be sent as additional debug data. The +library makes a copy of the memory region pointed by opaque_data +with the length opaque_data_len, so the caller does not need to +keep this memory after the return of this function. If the +opaque_data_len is 0, the opaque_data could be NULL.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Submits WINDOW_UPDATE frame.
+The flags is currently ignored and should be +NGHTTP2_FLAG_NONE.
+If the window_size_increment is positive, the WINDOW_UPDATE with +that value as window_size_increment is queued. If the +window_size_increment is larger than the received bytes from the +remote endpoint, the local window size is increased by that +difference.
+If the window_size_increment is negative, the local window size +is decreased by -window_size_increment. If +NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE (or +NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE if stream_id +is 0) is not set and the library decided that the WINDOW_UPDATE +should be submitted, then WINDOW_UPDATE is queued with the current +received bytes count.
+If the window_size_increment is 0, the function does nothing and +returns 0.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Compares lhs->name with lhs->namelen bytes and rhs->name with +rhs->namelen bytes. Returns negative integer if lhs->name is found +to be less than rhs->name; or returns positive integer if lhs->name +is found to be greater than rhs->name; or returns 0 otherwise.
+A helper function for dealing with NPN in client side. The in +contains server’s protocol in preferable order. The format of in +is length-prefixed and not null-terminated. For example, +HTTP-draft-04/2.0 and http/1.1 stored in in like this:
+in[0] = 17
+in[1..17] = "HTTP-draft-04/2.0"
+in[18] = 8
+in[19..26] = "http/1.1"
+inlen = 27
+The selection algorithm is as follows:
+Selecting HTTP-draft-04/2.0 means that HTTP-draft-04/2.0 is +written into *out and its length (which is 17) is +assigned to *outlen.
+See http://technotes.googlecode.com/git/nextprotoneg.html for more +details about NPN.
+To use this method you should do something like:
+static int select_next_proto_cb(SSL* ssl,
+ unsigned char **out,
+ unsigned char *outlen,
+ const unsigned char *in,
+ unsigned int inlen,
+ void *arg)
+{
+ int rv;
+ rv = nghttp2_select_next_protocol(out, outlen, in, inlen);
+ if(rv == 1) {
+ ((MyType*)arg)->http2_selected = 1;
+ }
+ return SSL_TLSEXT_ERR_OK;
+}
+...
+SSL_CTX_set_next_proto_select_cb(ssl_ctx, select_next_proto_cb, my_obj);
+Note that the HTTP/2.0 spec does use ALPN instead of NPN. This +function is provided for transitional period before ALPN is got +implemented in major SSL/TLS libraries.
+A helper function to set up a per request gzip stream to inflate data.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+Frees the inflate stream. The inflater may be NULL.
+Inflates data in in with the length *inlen_ptr and stores the +inflated data to out which has allocated size at least +*outlen_ptr. On return, *outlen_ptr is updated to represent +the number of data written in out. Similarly, *inlen_ptr is +updated to represent the number of input bytes processed.
+This function returns 0 if it succeeds, or one of the following +negative error codes:
+The example follows:
+void on_data_chunk_recv_callback(nghttp2_session *session,
+ uint8_t flags,
+ int32_t stream_id,
+ const uint8_t *data, size_t len,
+ void *user_data)
+{
+ ...
+ req = nghttp2_session_get_stream_user_data(session, stream_id);
+ nghttp2_gzip *inflater = req->inflater;
+ while(len > 0) {
+ uint8_t out[MAX_OUTLEN];
+ size_t outlen = MAX_OUTLEN;
+ size_t tlen = len;
+ int rv;
+ rv = nghttp2_gzip_inflate(inflater, out, &outlen, data, &tlen);
+ if(rv != 0) {
+ nghttp2_submit_rst_stream(session, stream_id,
+ NGHTTP2_INTERNAL_ERROR);
+ break;
+ }
+ ... Do stuff ...
+ data += tlen;
+ len -= tlen;
+ }
+ ....
+}
+Returns a pointer to a nghttp2_info struct with version information about +the run-time library in use. The least_version argument can be set to a +24 bit numerical value for the least accepted version number and if the +condition is not met, this function will return a NULL. Pass in 0 to skip +the version checking.
++ Enter search terms or a module, class or function name. +
+This is an experimental implementation of Hypertext Transfer Protocol +version 2.0.
+Contents:
++ Enter search terms or a module, class or function name. +
+/*
+ * nghttp2 - HTTP/2.0 C Library
+ *
+ * Copyright (c) 2013 Tatsuhiro Tsujikawa
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+#ifndef NGHTTP2_H
+#define NGHTTP2_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdlib.h>
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <nghttp2/nghttp2ver.h>
+
+/**
+ * @macro
+ *
+ * The protocol version identification of this library supports.
+ */
+#define NGHTTP2_PROTO_VERSION_ID "HTTP-draft-07/2.0"
+/**
+ * @macro
+ *
+ * The length of :macro:`NGHTTP2_PROTO_VERSION_ID`.
+ */
+#define NGHTTP2_PROTO_VERSION_ID_LEN 17
+
+struct nghttp2_session;
+/**
+ * @struct
+ *
+ * The primary structure to hold the resources needed for a HTTP/2.0
+ * session. The details of this structure are intentionally hidden
+ * from the public API.
+ */
+typedef struct nghttp2_session nghttp2_session;
+
+/**
+ * @macro
+ *
+ * The age of :type:`nghttp2_info`
+ */
+#define NGHTTP2_VERSION_AGE 1
+
+/**
+ * @struct
+ *
+ * This struct is what `nghttp2_version()` returns. It holds
+ * information about the particular nghttp2 version.
+ */
+typedef struct {
+ /**
+ * Age of this struct. This instance of nghttp2 sets it to
+ * :macro:`NGHTTP2_VERSION_AGE` but a future version may bump it and
+ * add more struct fields at the bottom
+ */
+ int age;
+ /**
+ * the :macro:`NGHTTP2_VERSION_NUM` number (since age ==1)
+ */
+ int version_num;
+ /**
+ * points to the :macro:`NGHTTP2_VERSION` string (since age ==1)
+ */
+ const char *version_str;
+ /**
+ * points to the :macro:`NGHTTP2_PROTO_VERSION_ID` string this
+ * instance implements (since age ==1)
+ */
+ const char *proto_str;
+ /* -------- the above fields all exist when age == 1 */
+} nghttp2_info;
+
+/**
+ * @macro
+ *
+ * The default priority value
+ */
+#define NGHTTP2_PRI_DEFAULT (1 << 30)
+/**
+ * @macro
+ *
+ * The lowest priority value
+ */
+#define NGHTTP2_PRI_LOWEST ((1U << 31) - 1)
+
+/**
+ * @macro
+ *
+ * The maximum window size
+ */
+#define NGHTTP2_MAX_WINDOW_SIZE ((int32_t)((1U << 31) - 1))
+
+/**
+ * @macro
+ *
+ * The initial window size for stream level flow control.
+ */
+#define NGHTTP2_INITIAL_WINDOW_SIZE ((1 << 16) - 1)
+/**
+ * @macro
+ *
+ * The initial window size for connection level flow control.
+ */
+#define NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE ((1 << 16) - 1)
+
+/**
+ * @macro
+ *
+ * The maximum header table size.
+ */
+#define NGHTTP2_MAX_HEADER_TABLE_SIZE (1 << 16)
+
+/**
+ * @macro
+ *
+ * The client connection header.
+ */
+#define NGHTTP2_CLIENT_CONNECTION_HEADER "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"
+/**
+ * @macro
+ *
+ * The length of :macro:`NGHTTP2_CLIENT_CONNECTION_HEADER`.
+ */
+#define NGHTTP2_CLIENT_CONNECTION_HEADER_LEN 24
+
+/**
+ * @enum
+ *
+ * Error codes used in this library. The code range is [-999, -500],
+ * inclusive. The following values are defined:
+ */
+typedef enum {
+ /**
+ * Invalid argument passed.
+ */
+ NGHTTP2_ERR_INVALID_ARGUMENT = -501,
+ /**
+ * The specified protocol version is not supported.
+ */
+ 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
+ * would block.
+ */
+ NGHTTP2_ERR_WOULDBLOCK = -504,
+ /**
+ * General protocol error
+ */
+ NGHTTP2_ERR_PROTO = -505,
+ /**
+ * The frame is invalid.
+ */
+ NGHTTP2_ERR_INVALID_FRAME = -506,
+ /**
+ * The peer performed a shutdown on the connection.
+ */
+ NGHTTP2_ERR_EOF = -507,
+ /**
+ * Used as a return value from
+ * :func:`nghttp2_data_source_read_callback` to indicate that data
+ * transfer is postponed. See
+ * :func:`nghttp2_data_source_read_callback` for details.
+ */
+ NGHTTP2_ERR_DEFERRED = -508,
+ /**
+ * Stream ID has reached the maximum value. Therefore no stream ID
+ * is available.
+ */
+ NGHTTP2_ERR_STREAM_ID_NOT_AVAILABLE = -509,
+ /**
+ * The stream is already closed; or the stream ID is invalid.
+ */
+ NGHTTP2_ERR_STREAM_CLOSED = -510,
+ /**
+ * RST_STREAM has been added to the outbound queue. The stream is in
+ * closing state.
+ */
+ NGHTTP2_ERR_STREAM_CLOSING = -511,
+ /**
+ * The transmission is not allowed for this stream (e.g., a frame
+ * with END_STREAM flag set has already sent).
+ */
+ NGHTTP2_ERR_STREAM_SHUT_WR = -512,
+ /**
+ * The stream ID is invalid.
+ */
+ NGHTTP2_ERR_INVALID_STREAM_ID = -513,
+ /**
+ * The state of the stream is not valid (e.g., DATA cannot be sent
+ * to the stream if response HEADERS has not been sent).
+ */
+ NGHTTP2_ERR_INVALID_STREAM_STATE = -514,
+ /**
+ * Another DATA frame has already been deferred.
+ */
+ NGHTTP2_ERR_DEFERRED_DATA_EXIST = -515,
+ /**
+ * Starting new stream is not allowed. (e.g., GOAWAY has been sent
+ * and/or received.
+ */
+ NGHTTP2_ERR_START_STREAM_NOT_ALLOWED = -516,
+ /**
+ * GOAWAY has already been sent.
+ */
+ NGHTTP2_ERR_GOAWAY_ALREADY_SENT = -517,
+ /**
+ * The received frame contains the invalid header block. (e.g.,
+ * There are duplicate header names; or the header names are not
+ * encoded in US-ASCII character set and not lower cased; or the
+ * header name is zero-length string; or the header value contains
+ * multiple in-sequence NUL bytes).
+ */
+ NGHTTP2_ERR_INVALID_HEADER_BLOCK = -518,
+ /**
+ * Indicates that the context is not suitable to perform the
+ * requested operation.
+ */
+ NGHTTP2_ERR_INVALID_STATE = -519,
+ /**
+ * The gzip error.
+ */
+ NGHTTP2_ERR_GZIP = -520,
+ /**
+ * The user callback function failed due to the temporal error.
+ */
+ NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE = -521,
+ /**
+ * The length of the frame is invalid, either too large or too small.
+ */
+ NGHTTP2_ERR_FRAME_SIZE_ERROR = -522,
+ /**
+ * Header block inflate/deflate error.
+ */
+ NGHTTP2_ERR_HEADER_COMP = -523,
+ /**
+ * Flow control error
+ */
+ NGHTTP2_ERR_FLOW_CONTROL = -524,
+ /**
+ * Insufficient buffer size given to function.
+ */
+ NGHTTP2_ERR_INSUFF_BUFSIZE = -525,
+ /**
+ * Callback was paused by the application
+ */
+ NGHTTP2_ERR_PAUSE = -526,
+ /**
+ * There are too many in-flight SETTING frame and no more
+ * transmission of SETTINGS is allowed.
+ */
+ NGHTTP2_ERR_TOO_MANY_INFLIGHT_SETTINGS = -527,
+ /**
+ * The server push is disabled.
+ */
+ NGHTTP2_ERR_PUSH_DISABLED = -528,
+ /**
+ * The errors < :enum:`NGHTTP2_ERR_FATAL` mean that the library is
+ * under unexpected condition and cannot process any further data
+ * reliably (e.g., out of memory).
+ */
+ NGHTTP2_ERR_FATAL = -900,
+ /**
+ * Out of memory. This is a fatal error.
+ */
+ NGHTTP2_ERR_NOMEM = -901,
+ /**
+ * The user callback function failed. This is a fatal error.
+ */
+ NGHTTP2_ERR_CALLBACK_FAILURE = -902
+} nghttp2_error;
+
+typedef enum {
+ NGHTTP2_MSG_MORE
+} nghttp2_io_flag;
+
+/**
+ * @struct
+ *
+ * The name/value pair, which mainly used to represent header fields.
+ */
+typedef struct {
+ /**
+ * The |name| byte string, which is not necessarily ``NULL``
+ * terminated.
+ */
+ uint8_t *name;
+ /**
+ * The |value| byte string, which is not necessarily ``NULL``
+ * terminated.
+ */
+ uint8_t *value;
+ /**
+ * The length of the |name|.
+ */
+ uint16_t namelen;
+ /**
+ * The length of the |value|.
+ */
+ uint16_t valuelen;
+} nghttp2_nv;
+
+/**
+ * @enum
+ * The control frame types in HTTP/2.0.
+ */
+typedef enum {
+ /**
+ * The DATA frame.
+ */
+ NGHTTP2_DATA = 0,
+ /**
+ * The HEADERS frame.
+ */
+ NGHTTP2_HEADERS = 1,
+ /**
+ * The PRIORITY frame.
+ */
+ NGHTTP2_PRIORITY = 2,
+ /**
+ * The RST_STREAM frame.
+ */
+ NGHTTP2_RST_STREAM = 3,
+ /**
+ * The SETTINGS frame.
+ */
+ NGHTTP2_SETTINGS = 4,
+ /**
+ * The PUSH_PROMISE frame.
+ */
+ NGHTTP2_PUSH_PROMISE = 5,
+ /**
+ * The PING frame.
+ */
+ NGHTTP2_PING = 6,
+ /**
+ * The GOAWAY frame.
+ */
+ NGHTTP2_GOAWAY = 7,
+ /**
+ * The WINDOW_UPDATE frame.
+ */
+ NGHTTP2_WINDOW_UPDATE = 9
+} nghttp2_frame_type;
+
+/**
+ * @enum
+ *
+ * The flags for HTTP/2.0 frames. This enum defines all flags for
+ * frames, assuming that the same flag name has the same mask.
+ */
+typedef enum {
+ /**
+ * No flag set.
+ */
+ NGHTTP2_FLAG_NONE = 0,
+ /**
+ * The END_STREAM flag.
+ */
+ NGHTTP2_FLAG_END_STREAM = 0x1,
+ /**
+ * The END_HEADERS flag.
+ */
+ NGHTTP2_FLAG_END_HEADERS = 0x4,
+ /**
+ * The PRIORITY flag.
+ */
+ NGHTTP2_FLAG_PRIORITY = 0x8,
+ /**
+ * The END_PUSH_PROMISE flag.
+ */
+ NGHTTP2_FLAG_END_PUSH_PROMISE = 0x4,
+ /**
+ * The ACK flag.
+ */
+ NGHTTP2_FLAG_ACK = 0x1
+} nghttp2_flag;
+
+/**
+ * @enum
+ * The SETTINGS ID.
+ */
+typedef enum {
+ /**
+ * SETTINGS_HEADER_TABLE_SIZE
+ */
+ NGHTTP2_SETTINGS_HEADER_TABLE_SIZE = 1,
+ /**
+ * SETTINGS_ENABLE_PUSH
+ */
+ NGHTTP2_SETTINGS_ENABLE_PUSH = 2,
+ /**
+ * SETTINGS_MAX_CONCURRENT_STREAMS
+ */
+ NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS = 4,
+ /**
+ * SETTINGS_INITIAL_WINDOW_SIZE
+ */
+ NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE = 7,
+ /**
+ * SETTINGS_FLOW_CONTROL_OPTIONS
+ */
+ NGHTTP2_SETTINGS_FLOW_CONTROL_OPTIONS = 10,
+ /**
+ * Maximum ID of :type:`nghttp2_settings_id`.
+ */
+ NGHTTP2_SETTINGS_MAX = 10
+} nghttp2_settings_id;
+
+/**
+ * @macro
+ * Default maximum concurrent streams.
+ */
+#define NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS ((1U << 31) - 1)
+
+/**
+ * @enum
+ * The status codes for the RST_STREAM and GOAWAY frames.
+ */
+typedef enum {
+ /**
+ * No errors.
+ */
+ NGHTTP2_NO_ERROR = 0,
+ /**
+ * PROTOCOL_ERROR
+ */
+ NGHTTP2_PROTOCOL_ERROR = 1,
+ /**
+ * INTERNAL_ERROR
+ */
+ NGHTTP2_INTERNAL_ERROR = 2,
+ /**
+ * FLOW_CONTROL_ERROR
+ */
+ NGHTTP2_FLOW_CONTROL_ERROR = 3,
+ /**
+ * SETTINGS_TIMEOUT
+ */
+ NGHTTP2_SETTINGS_TIMEOUT = 4,
+ /**
+ * STREAM_CLOSED
+ */
+ NGHTTP2_STREAM_CLOSED = 5,
+ /**
+ * FRAME_SIZE_ERROR
+ */
+ NGHTTP2_FRAME_SIZE_ERROR = 6,
+ /**
+ * REFUSED_STREAM
+ */
+ NGHTTP2_REFUSED_STREAM = 7,
+ /**
+ * CANCEL
+ */
+ NGHTTP2_CANCEL = 8,
+ /**
+ * COMPRESSION_ERROR
+ */
+ NGHTTP2_COMPRESSION_ERROR = 9,
+ /**
+ * CONNECT_ERROR
+ */
+ NGHTTP2_CONNECT_ERROR = 10,
+ /**
+ * ENHANCE_YOUR_CALM
+ */
+ NGHTTP2_ENHANCE_YOUR_CALM = 420
+} nghttp2_error_code;
+
+/**
+ * @struct
+ * The frame header.
+ */
+typedef struct {
+ /**
+ * The length field of this frame, excluding frame header.
+ */
+ uint16_t length;
+ /**
+ * The type of this frame. See `nghttp2_frame`.
+ */
+ uint8_t type;
+ /**
+ * The flags.
+ */
+ uint8_t flags;
+ /**
+ * The stream identifier (aka, stream ID)
+ */
+ int32_t stream_id;
+} nghttp2_frame_hd;
+
+
+/**
+ * @union
+ *
+ * This union represents the some kind of data source passed to
+ * :type:`nghttp2_data_source_read_callback`.
+ */
+typedef union {
+ /**
+ * The integer field, suitable for a file descriptor.
+ */
+ int fd;
+ /**
+ * The pointer to an arbitrary object.
+ */
+ void *ptr;
+} nghttp2_data_source;
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when the library wants to read data from
+ * the |source|. The read data is sent in the stream |stream_id|. The
+ * 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.
+ */
+typedef ssize_t (*nghttp2_data_source_read_callback)
+(nghttp2_session *session, int32_t stream_id,
+ uint8_t *buf, size_t length, int *eof,
+ nghttp2_data_source *source, void *user_data);
+
+/**
+ * @struct
+ *
+ * This struct represents the data source and the way to read a chunk
+ * of data from it.
+ */
+typedef struct {
+ /**
+ * The data source.
+ */
+ nghttp2_data_source source;
+ /**
+ * The callback function to read a chunk of data from the |source|.
+ */
+ nghttp2_data_source_read_callback read_callback;
+} nghttp2_data_provider;
+
+/**
+ * @enum
+ *
+ * The category of HEADERS, which indicates the role of the frame. In
+ * HTTP/2.0 spec, request, response, push response and other arbitrary
+ * headers (e.g., trailers) are all called just HEADERS. To give the
+ * application the role of incoming HEADERS frame, we define several
+ * categories.
+ */
+typedef enum {
+ /**
+ * The HEADERS frame is opening new stream, which is analogous to
+ * SYN_STREAM in SPDY.
+ */
+ NGHTTP2_HCAT_REQUEST = 0,
+ /**
+ * The HEADERS frame is the first response headers, which is
+ * analogous to SYN_REPLY in SPDY.
+ */
+ NGHTTP2_HCAT_RESPONSE = 1,
+ /**
+ * The HEADERS frame is the first headers sent against reserved
+ * stream.
+ */
+ NGHTTP2_HCAT_PUSH_RESPONSE = 2,
+ /**
+ * The HEADERS frame which does not apply for the above categories,
+ * which is analogous to HEADERS in SPDY.
+ */
+ NGHTTP2_HCAT_HEADERS = 3
+} nghttp2_headers_category;
+
+/**
+ * @struct
+ * The HEADERS frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The priority.
+ */
+ int32_t pri;
+ /**
+ * The name/value pairs.
+ */
+ nghttp2_nv *nva;
+ /**
+ * The number of name/value pairs in |nva|.
+ */
+ size_t nvlen;
+ nghttp2_headers_category cat;
+} nghttp2_headers;
+
+/**
+ * @struct
+ * The PRIORITY frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The priority.
+ */
+ int32_t pri;
+} nghttp2_priority;
+
+/**
+ * @struct
+ * The RST_STREAM frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The error code. See :type:`nghttp2_error_code`.
+ */
+ nghttp2_error_code error_code;
+} nghttp2_rst_stream;
+
+/**
+ * @struct
+ * The SETTINGS ID/Value pair. It has the following members:
+ */
+typedef struct {
+ /**
+ * The SETTINGS ID. See :type:`nghttp2_settings_id`.
+ */
+ int32_t settings_id;
+ /**
+ * The value of this entry.
+ */
+ uint32_t value;
+} nghttp2_settings_entry;
+
+/**
+ * @struct
+ * The SETTINGS frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The number of SETTINGS ID/Value pairs in |iv|.
+ */
+ size_t niv;
+ /**
+ * The pointer to the array of SETTINGS ID/Value pair.
+ */
+ nghttp2_settings_entry *iv;
+} nghttp2_settings;
+
+/**
+ * @struct
+ * The PUSH_PROMISE frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The promised stream ID
+ */
+ int32_t promised_stream_id;
+ /**
+ * The name/value pairs.
+ */
+ nghttp2_nv *nva;
+ /**
+ * The number of name/value pairs in |nva|.
+ */
+ size_t nvlen;
+} nghttp2_push_promise;
+
+/**
+ * @struct
+ * The PING frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The opaque data
+ */
+ uint8_t opaque_data[8];
+} nghttp2_ping;
+
+/**
+ * @struct
+ * The GOAWAY frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The last stream stream ID.
+ */
+ int32_t last_stream_id;
+ /**
+ * The error code. See :type:`nghttp2_error_code`.
+ */
+ nghttp2_error_code error_code;
+ /**
+ * The additional debug data
+ */
+ uint8_t *opaque_data;
+ /**
+ * The length of |opaque_data| member.
+ */
+ size_t opaque_data_len;
+} nghttp2_goaway;
+
+/**
+ * @struct
+ *
+ * The WINDOW_UPDATE frame. It has the following members:
+ */
+typedef struct {
+ /**
+ * The frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The window size increment.
+ */
+ int32_t window_size_increment;
+} nghttp2_window_update;
+
+/**
+ * @union
+ *
+ * This union includes all frames to pass them to various function
+ * calls as nghttp2_frame type. The DATA frame is intentionally
+ * omitted from here.
+ */
+typedef union {
+ /**
+ * The frame header, which is convenient to inspect frame header.
+ */
+ nghttp2_frame_hd hd;
+ /**
+ * The HEADERS frame.
+ */
+ nghttp2_headers headers;
+ /**
+ * The PRIORITY frame.
+ */
+ nghttp2_priority priority;
+ /**
+ * The RST_STREAM frame.
+ */
+ nghttp2_rst_stream rst_stream;
+ /**
+ * The SETTINGS frame.
+ */
+ nghttp2_settings settings;
+ /**
+ * The PUSH_PROMISE frame.
+ */
+ nghttp2_push_promise push_promise;
+ /**
+ * The PING frame.
+ */
+ nghttp2_ping ping;
+ /**
+ * The GOAWAY frame.
+ */
+ nghttp2_goaway goaway;
+ /**
+ * The WINDOW_UPDATE frame.
+ */
+ nghttp2_window_update window_update;
+} nghttp2_frame;
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when |session| wants to send data to the
+ * remote peer. The implementation of this function must send at most
+ * |length| bytes of data stored in |data|. The |flags| is currently
+ * not used and always 0. It must return the number of bytes sent if
+ * it succeeds. If it cannot send any single byte without blocking,
+ * it must return :enum:`NGHTTP2_ERR_WOULDBLOCK`. For other errors, it
+ * must return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`. The |user_data|
+ * pointer is the third argument passed in to the call to
+ * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
+ */
+typedef ssize_t (*nghttp2_send_callback)
+(nghttp2_session *session,
+ const uint8_t *data, size_t length, int flags, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when |session| wants to receive data from
+ * the remote peer. The implementation of this function must read at
+ * most |length| bytes of data and store it in |buf|. The |flags| is
+ * currently not used and always 0. It must return the number of bytes
+ * written in |buf| if it succeeds. If it cannot read any single byte
+ * without blocking, it must return :enum:`NGHTTP2_ERR_WOULDBLOCK`. If
+ * it gets EOF before it reads any single byte, it must return
+ * :enum:`NGHTTP2_ERR_EOF`. For other errors, it must return
+ * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`. Returning 0 is treated as
+ * :enum:`NGHTTP2_ERR_WOULDBLOCK`. The |user_data| pointer is the
+ * third argument passed in to the call to
+ * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
+ */
+typedef ssize_t (*nghttp2_recv_callback)
+(nghttp2_session *session,
+ uint8_t *buf, size_t length, int flags, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked by `nghttp2_session_recv()` when a
+ * non-DATA 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 the application uses `nghttp2_session_mem_recv()`, it can return
+ * :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`
+ * return without processing further input bytes. The |frame|
+ * parameter is retained until `nghttp2_session_continue()` is
+ * called. The application must retain the input bytes which was used
+ * to produce the |frame| parameter, because it may refer to the
+ * memory region included in the input bytes. The application which
+ * returns :enum:`NGHTTP2_ERR_PAUSE` must call
+ * `nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.
+ *
+ * The implementation of this function must return 0 if it
+ * succeeds. It may return :enum:`NGHTTP2_ERR_PAUSE`. If the other
+ * nonzero value is returned, it is treated as fatal error and
+ * `nghttp2_session_recv()` and `nghttp2_session_send()` functions
+ * immediately return :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`.
+ */
+typedef int (*nghttp2_on_frame_recv_callback)
+(nghttp2_session *session, const nghttp2_frame *frame, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked by `nghttp2_session_recv()` when an
+ * invalid non-DATA frame is received. The |error_code| is one of the
+ * :enum:`nghttp2_error_code` and indicates the error. When this
+ * 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()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_invalid_frame_recv_callback)
+(nghttp2_session *session, const nghttp2_frame *frame,
+ nghttp2_error_code error_code, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when a chunk of data in DATA frame is
+ * received. The |stream_id| is the stream ID this DATA frame belongs
+ * to. The |flags| is the flags of DATA frame which this data chunk is
+ * contained. ``(flags & NGHTTP2_FLAG_END_STREAM) != 0`` does not
+ * necessarily mean this chunk of data is the last one in the
+ * stream. You should use :type:`nghttp2_on_data_recv_callback` to
+ * know all data frames are 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 the application uses `nghttp2_session_mem_recv()`, it can return
+ * :enum:`NGHTTP2_ERR_PAUSE` to make `nghttp2_session_mem_recv()`
+ * return without processing further input bytes. The |frame|
+ * parameter is retained until `nghttp2_session_continue()` is
+ * called. The application must retain the input bytes which was used
+ * to produce the |frame| parameter, because it may refer to the
+ * memory region included in the input bytes. The application which
+ * returns :enum:`NGHTTP2_ERR_PAUSE` must call
+ * `nghttp2_session_continue()` before `nghttp2_session_mem_recv()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_data_chunk_recv_callback)
+(nghttp2_session *session, uint8_t flags, int32_t stream_id,
+ const uint8_t *data, size_t len, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when DATA frame is received. The actual
+ * data it contains are received by
+ * :type:`nghttp2_on_data_chunk_recv_callback`. The |user_data|
+ * pointer is the third argument passed in to the call to
+ * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_data_recv_callback)
+(nghttp2_session *session, uint16_t length, uint8_t flags, int32_t stream_id,
+ void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked before the non-DATA frame |frame| is
+ * sent. This may be useful, for example, to know the stream ID of
+ * HEADERS and PUSH_PROMISE frame (see also
+ * `nghttp2_session_get_stream_user_data()`), which is not assigned
+ * when it was queued. The |user_data| pointer is the third argument
+ * passed in to the call to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_before_frame_send_callback)
+(nghttp2_session *session, const nghttp2_frame *frame, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked after the non-DATA frame |frame| is sent.
+ * The |user_data| pointer is the third argument passed in to the call
+ * to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_frame_send_callback)
+(nghttp2_session *session, const nghttp2_frame *frame, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked after the non-DATA frame |frame| is not
+ * sent because of the error. The error is indicated by the
+ * |lib_error_code|, which is one of the values defined in
+ * :type:`nghttp2_error`. The |user_data| pointer is the third
+ * argument passed in to the call to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_frame_not_send_callback)
+(nghttp2_session *session, const nghttp2_frame *frame, int lib_error_code,
+ void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked after DATA frame is sent. The |user_data|
+ * pointer is the third argument passed in to the call to
+ * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_data_send_callback)
+(nghttp2_session *session, uint16_t length, uint8_t flags, int32_t stream_id,
+ void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when the stream |stream_id| is
+ * closed. The reason of closure is indicated by the |error_code|. The
+ * stream_user_data, which was specified in `nghttp2_submit_request()`
+ * or `nghttp2_submit_headers()`, is still available in this
+ * function. The |user_data| pointer is the third argument passed in
+ * to the call to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_stream_close_callback)
+(nghttp2_session *session, int32_t stream_id, nghttp2_error_code error_code,
+ void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when the request from the remote peer is
+ * received. In other words, the frame with END_STREAM flag set is
+ * received. In HTTP, this means HTTP request, including request
+ * body, is fully received. The |user_data| pointer is the third
+ * argument passed in to the call to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_request_recv_callback)
+(nghttp2_session *session, int32_t stream_id, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when the received control frame octets
+ * could not be parsed correctly. The |type| indicates the type of
+ * received non-DATA frame. The |head| is the pointer to the header of
+ * the received frame. The |headlen| is the length of the
+ * |head|. According to the spec, the |headlen| is always 8. In other
+ * words, the |head| is the first 8 bytes of the received frame. The
+ * |payload| is the pointer to the data portion of the received frame.
+ * The |payloadlen| is the length of the |payload|. This is the data
+ * after the length field. The |lib_error_code| is one of the error
+ * code defined in :enum:`nghttp2_error` and indicates the error. The
+ * |user_data| pointer is the third argument passed in to the call to
+ * `nghttp2_session_client_new()` or `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_frame_recv_parse_error_callback)
+(nghttp2_session *session, nghttp2_frame_type type,
+ const uint8_t *head, size_t headlen,
+ const uint8_t *payload, size_t payloadlen,
+ int lib_error_code, void *user_data);
+
+/**
+ * @functypedef
+ *
+ * Callback function invoked when the received frame type is
+ * unknown. The |head| is the pointer to the header of the received
+ * frame. The |headlen| is the length of the |head|. According to the
+ * spec, the |headlen| is always 8. In other words, the |head| is the
+ * first 8 bytes of the received frame. The |payload| is the pointer
+ * to the data portion of the received frame. The |payloadlen| is the
+ * length of the |payload|. This is the data after the length
+ * field. The |user_data| pointer is the third argument passed in to
+ * the call to `nghttp2_session_client_new()` or
+ * `nghttp2_session_server_new()`.
+ *
+ * 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`.
+ */
+typedef int (*nghttp2_on_unknown_frame_recv_callback)
+(nghttp2_session *session,
+ const uint8_t *head, size_t headlen,
+ const uint8_t *payload, size_t payloadlen,
+ void *user_data);
+
+/**
+ * @struct
+ *
+ * Callback functions.
+ */
+typedef struct {
+ /**
+ * Callback function invoked when the |session| wants to send data
+ * to the remote peer.
+ */
+ nghttp2_send_callback send_callback;
+ /**
+ * Callback function invoked when the |session| wants to receive
+ * data from the remote peer.
+ */
+ nghttp2_recv_callback recv_callback;
+ /**
+ * Callback function invoked by `nghttp2_session_recv()` when a
+ * non-DATA frame is received.
+ */
+ nghttp2_on_frame_recv_callback on_frame_recv_callback;
+ /**
+ * Callback function invoked by `nghttp2_session_recv()` when an
+ * invalid non-DATA frame is received.
+ */
+ nghttp2_on_invalid_frame_recv_callback on_invalid_frame_recv_callback;
+ /**
+ * Callback function invoked when a chunk of data in DATA frame is
+ * received.
+ */
+ nghttp2_on_data_chunk_recv_callback on_data_chunk_recv_callback;
+ /**
+ * Callback function invoked when DATA frame is received.
+ */
+ nghttp2_on_data_recv_callback on_data_recv_callback;
+ /**
+ * Callback function invoked before the non-DATA frame is sent.
+ */
+ nghttp2_before_frame_send_callback before_frame_send_callback;
+ /**
+ * Callback function invoked after the non-DATA frame is sent.
+ */
+ nghttp2_on_frame_send_callback on_frame_send_callback;
+ /**
+ * The callback function invoked when a non-DATA frame is not sent
+ * because of an error.
+ */
+ nghttp2_on_frame_not_send_callback on_frame_not_send_callback;
+ /**
+ * Callback function invoked after DATA frame is sent.
+ */
+ nghttp2_on_data_send_callback on_data_send_callback;
+ /**
+ * Callback function invoked when the stream is closed.
+ */
+ nghttp2_on_stream_close_callback on_stream_close_callback;
+ /**
+ * Callback function invoked when request from the remote peer is
+ * received.
+ */
+ nghttp2_on_request_recv_callback on_request_recv_callback;
+ /**
+ * Callback function invoked when the received non-DATA frame octets
+ * could not be parsed correctly.
+ */
+ nghttp2_on_frame_recv_parse_error_callback
+ on_frame_recv_parse_error_callback;
+ /**
+ * Callback function invoked when the received frame type is
+ * unknown.
+ */
+ nghttp2_on_unknown_frame_recv_callback on_unknown_frame_recv_callback;
+} nghttp2_session_callbacks;
+
+/**
+ * @function
+ *
+ * Initializes |*session_ptr| for client use. The all members of
+ * |callbacks| are copied to |*session_ptr|. Therefore |*session_ptr|
+ * does not store |callbacks|. |user_data| is an arbitrary user
+ * supplied data, which will be passed to the callback functions.
+ *
+ * The :member:`nghttp2_session_callbacks.send_callback` must be
+ * specified. If the application code uses `nghttp2_session_recv()`,
+ * the :member:`nghttp2_session_callbacks.recv_callback` must be
+ * specified. The other members of |callbacks| can be ``NULL``.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_session_client_new(nghttp2_session **session_ptr,
+ const nghttp2_session_callbacks *callbacks,
+ void *user_data);
+
+/**
+ * @function
+ *
+ * Initializes |*session_ptr| for server use. The all members of
+ * |callbacks| are copied to |*session_ptr|. Therefore |*session_ptr|
+ * does not store |callbacks|. |user_data| is an arbitrary user
+ * supplied data, which will be passed to the callback functions.
+ *
+ * The :member:`nghttp2_session_callbacks.send_callback` must be
+ * specified. If the application code uses `nghttp2_session_recv()`,
+ * the :member:`nghttp2_session_callbacks.recv_callback` must be
+ * specified. The other members of |callbacks| can be ``NULL``.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_session_server_new(nghttp2_session **session_ptr,
+ const nghttp2_session_callbacks *callbacks,
+ void *user_data);
+
+/**
+ * @function
+ *
+ * Frees any resources allocated for |session|. If |session| is
+ * ``NULL``, this function does nothing.
+ */
+void nghttp2_session_del(nghttp2_session *session);
+
+/**
+ * @enum
+ *
+ * Configuration options for :type:`nghttp2_session`.
+ */
+typedef enum {
+ /**
+ * This option prevents the library from sending WINDOW_UPDATE for a
+ * stream automatically. If this option is set, the application is
+ * responsible for sending WINDOW_UPDATE using
+ * `nghttp2_submit_window_update`.
+ */
+ NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE = 1,
+ /**
+ * This option prevents the library from sending WINDOW_UPDATE for a
+ * connection automatically. If this option is set, the application
+ * is responsible for sending WINDOW_UPDATE with stream ID 0 using
+ * `nghttp2_submit_window_update`.
+ */
+ NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE = 2,
+ /**
+ * This option sets the SETTINGS_MAX_CONCURRENT_STREAMS value of
+ * remote endpoint as if it is received in SETTINGS frame. Without
+ * specifying this option, before the local endpoint receives
+ * SETTINGS_MAX_CONCURRENT_STREAMS in SETTINGS frame from remote
+ * endpoint, SETTINGS_MAX_CONCURRENT_STREAMS is unlimited. This may
+ * cause problem if local endpoint submits lots of requests
+ * initially and sending them at once to the remote peer may lead to
+ * the rejection of some requests. Specifying this option to the
+ * sensible value, say 100, may avoid this kind of issue. This value
+ * will be overwritten if the local endpoint receives
+ * SETTINGS_MAX_CONCURRENT_STREAMS from the remote endpoint.
+ */
+ NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS = 3
+} nghttp2_opt;
+
+/**
+ * @function
+ *
+ * Sets the configuration option for the |session|. The |optname| is
+ * one of :type:`nghttp2_opt`. The |optval| is the pointer to the
+ * option value and the |optlen| is the size of |*optval|. The
+ * required type of |optval| varies depending on the |optname|. See
+ * below.
+ *
+ * The following |optname| are supported:
+ *
+ * :enum:`NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE`
+ * The |optval| must be a pointer to ``int``. If the |*optval| is
+ * nonzero, the library will not send WINDOW_UPDATE for a stream
+ * automatically. Therefore, the application is responsible for
+ * sending WINDOW_UPDATE using
+ * `nghttp2_submit_window_update`. This option defaults to 0.
+ *
+ * :enum:`NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE`
+ * The |optval| must be a pointer to ``int``. If the |*optval| is
+ * nonzero, the library will not send WINDOW_UPDATE for connection
+ * automatically. Therefore, the application is responsible for
+ * sending WINDOW_UPDATE using
+ * `nghttp2_submit_window_update`. This option defaults to 0.
+ *
+ * :enum:`NGHTTP2_OPT_PEER_MAX_CONCURRENT_STREAMS`
+ * The |optval| must be a pointer to ``ssize_t``. It is an error
+ * if |*optval| is 0 or negative.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |optname| is not supported; or the |optval| and/or the
+ * |optlen| are invalid.
+ */
+int nghttp2_session_set_option(nghttp2_session *session,
+ int optname, void *optval, size_t optlen);
+
+/**
+ * @function
+ *
+ * Sends pending frames to the remote peer.
+ *
+ * This function retrieves the highest prioritized frame from the
+ * outbound queue and sends it to the remote peer. It does this as
+ * many as possible until the user callback
+ * :member:`nghttp2_session_callbacks.send_callback` returns
+ * :enum:`NGHTTP2_ERR_WOULDBLOCK` or the outbound queue becomes empty.
+ * This function calls several callback functions which are passed
+ * when initializing the |session|. Here is the simple time chart
+ * which tells when each callback is invoked:
+ *
+ * 1. Get the next frame to send from outbound queue.
+ * 2. Prepare transmission of the frame.
+ * 3. If the control frame cannot be sent because some preconditions
+ * are not met (e.g., request HEADERS cannot be sent after
+ * GOAWAY),
+ * :member:`nghttp2_session_callbacks.on_ctrl_not_send_callback` is
+ * invoked. Abort the following steps.
+ * 4. If the frame is request HEADERS, the stream is opened
+ * here.
+ * 5. :member:`nghttp2_session_callbacks.before_ctrl_send_callback` is
+ * invoked.
+ * 6. :member:`nghttp2_session_callbacks.send_callback` is invoked one
+ * or more times to send the frame.
+ * 7. If the frame is a control frame,
+ * :member:`nghttp2_session_callbacks.on_ctrl_send_callback` is
+ * invoked.
+ * 8. If the frame is a DATA frame,
+ * :member:`nghttp2_session_callbacks.on_data_send_callback` is
+ * invoked.
+ * 9. If the transmission of the frame triggers closure of the stream,
+ * the stream is closed and
+ * :member:`nghttp2_session_callbacks.on_stream_close_callback` is
+ * invoked.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`
+ * The callback function failed.
+ */
+int nghttp2_session_send(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Receives frames from the remote peer.
+ *
+ * This function receives as many frames as possible until the user
+ * callback :member:`nghttp2_session_callbacks.recv_callback` returns
+ * :enum:`NGHTTP2_ERR_WOULDBLOCK`. This function calls several
+ * callback functions which are passed when initializing the
+ * |session|. Here is the simple time chart which tells when each
+ * callback is invoked:
+ *
+ * 1. :member:`nghttp2_session_callbacks.recv_callback` is invoked one
+ * or more times to receive frame header.
+ * 2. If the frame is DATA frame:
+ *
+ * 2.1. :member:`nghttp2_session_callbacks.recv_callback` is invoked
+ * to receive DATA payload. For each chunk of data,
+ * :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`
+ * is invoked.
+ * 2.2. If one DATA frame is completely received,
+ * :member:`nghttp2_session_callbacks.on_data_recv_callback` is
+ * invoked. If the frame is the final frame of the request,
+ * :member:`nghttp2_session_callbacks.on_request_recv_callback`
+ * is invoked. If the reception of the frame triggers the
+ * closure of the stream,
+ * :member:`nghttp2_session_callbacks.on_stream_close_callback`
+ * is invoked.
+ *
+ * 3. If the frame is the control frame:
+ *
+ * 3.1. :member:`nghttp2_session_callbacks.recv_callback` is invoked
+ * one or more times to receive whole frame.
+ * 3.2. If the received frame is valid,
+ * :member:`nghttp2_session_callbacks.on_ctrl_recv_callback` is
+ * invoked. If the frame is the final frame of the request,
+ * :member:`nghttp2_session_callbacks.on_request_recv_callback`
+ * is invoked. If the reception of the frame triggers the
+ * closure of the stream,
+ * :member:`nghttp2_session_callbacks.on_stream_close_callback`
+ * is invoked.
+ * 3.3. If the received frame is unpacked but is interpreted as
+ * invalid,
+ * :member:`nghttp2_session_callbacks.on_invalid_ctrl_recv_callback`
+ * is invoked.
+ * 3.4. If the received frame could not be unpacked correctly,
+ * :member:`nghttp2_session_callbacks.on_ctrl_recv_parse_error_callback`
+ * is invoked.
+ * 3.5. If the received frame type is unknown,
+ * :member:`nghttp2_session_callbacks.on_unknown_ctrl_recv_callback`
+ * is invoked.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_EOF`
+ * The remote peer did shutdown on the connection.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`
+ * The callback function failed.
+ */
+int nghttp2_session_recv(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Processes data |in| as an input from the remote endpoint. The
+ * |inlen| indicates the number of bytes in the |in|.
+ *
+ * This function behaves like `nghttp2_session_recv()` except that it
+ * does not use :member:`nghttp2_session_callbacks.recv_callback` to
+ * receive data; the |in| is the only data for the invocation of this
+ * function. If all bytes are processed, this function returns. The
+ * other callbacks are called in the same way as they are in
+ * `nghttp2_session_recv()`.
+ *
+ * In the current implementation, this function always tries to
+ * processes all input data unless either an error occurs or
+ * :enum:`NGHTTP2_ERR_PAUSE` is returned from
+ * :member:`nghttp2_session_callbacks.on_frame_recv_callback` or
+ * :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
+ * If :enum:`NGHTTP2_ERR_PAUSE` is used, the return value includes the
+ * number of bytes which was used to produce the data or frame for the
+ * callback.
+ *
+ * This function returns the number of processed bytes, or one of the
+ * following negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`
+ * The callback function failed.
+ */
+ssize_t nghttp2_session_mem_recv(nghttp2_session *session,
+ const uint8_t *in, size_t inlen);
+
+/**
+ * @function
+ *
+ * Perform post-processing after `nghttp2_session_mem_recv()` was
+ * paused by :enum:`NGHTTP2_ERR_PAUSE` from
+ * :member:`nghttp2_session_callbacks.on_frame_recv_callback` or
+ * :member:`nghttp2_session_callbacks.on_data_chunk_recv_callback`.
+ *
+ * This function frees resources associated with paused frames. It
+ * may also call additional callbacks, such as
+ * :member:`nghttp2_session_callbacks.on_stream_close_callback`.
+ *
+ * If this function succeeds, the application can call
+ * `nghttp2_session_mem_recv()` again.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_CALLBACK_FAILURE`
+ * The callback function failed.
+ *
+ */
+int nghttp2_session_continue(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Puts back previously deferred DATA frame in the stream |stream_id|
+ * to the outbound queue.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The stream does not exist or no deferred data exist.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_session_resume_data(nghttp2_session *session, int32_t stream_id);
+
+/**
+ * @function
+ *
+ * Returns nonzero value if |session| wants to receive data from the
+ * remote peer.
+ *
+ * If both `nghttp2_session_want_read()` and
+ * `nghttp2_session_want_write()` return 0, the application should
+ * drop the connection.
+ */
+int nghttp2_session_want_read(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Returns nonzero value if |session| wants to send data to the remote
+ * peer.
+ *
+ * If both `nghttp2_session_want_read()` and
+ * `nghttp2_session_want_write()` return 0, the application should
+ * drop the connection.
+ */
+int nghttp2_session_want_write(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Returns stream_user_data for the stream |stream_id|. The
+ * stream_user_data is provided by `nghttp2_submit_request()` or
+ * `nghttp2_submit_syn_stream()`. If the stream is initiated by the
+ * remote endpoint, stream_user_data is always ``NULL``. If the stream
+ * is initiated by the local endpoint and ``NULL`` is given in
+ * `nghttp2_submit_request()` or `nghttp2_submit_syn_stream()`, then
+ * this function returns ``NULL``. If the stream does not exist, this
+ * function returns ``NULL``.
+ */
+void* nghttp2_session_get_stream_user_data(nghttp2_session *session,
+ int32_t stream_id);
+
+/**
+ * @function
+ *
+ * Returns the number of frames in the outbound queue. This does not
+ * include the deferred DATA frames.
+ */
+size_t nghttp2_session_get_outbound_queue_size(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Returns the number of DATA payload in bytes received without
+ * WINDOW_UPDATE transmission for the stream |stream_id|. The local
+ * (receive) window size can be adjusted by
+ * `nghttp2_submit_window_update()`. This function takes into account
+ * that and returns effective data length. In particular, if the
+ * local window size is reduced by submitting negative
+ * window_size_increment with `nghttp2_submit_window_update()`, this
+ * function returns the number of bytes less than actually received.
+ *
+ * If flow control is disabled for that stream, this function returns
+ * 0.
+ *
+ * This function returns -1 if it fails.
+ */
+int32_t nghttp2_session_get_stream_effective_recv_data_length
+(nghttp2_session *session, int32_t stream_id);
+
+/**
+ * @function
+ *
+ * Returns the local (receive) window size for the stream
+ * |stream_id|. The local window size can be adjusted by
+ * `nghttp2_submit_window_update()`. This function takes into account
+ * that and returns effective window size.
+ *
+ * This function returns -1 if it fails.
+ */
+int32_t nghttp2_session_get_stream_effective_local_window_size
+(nghttp2_session *session, int32_t stream_id);
+
+/**
+ * @function
+ *
+ * Returns the number of DATA payload in bytes received without
+ * WINDOW_UPDATE transmission for a connection. The local (receive)
+ * window size can be adjusted by
+ * `nghttp2_submit_window_update()`. This function takes into account
+ * that and returns effective data length. In particular, if the local
+ * window size is reduced by submitting negative window_size_increment
+ * with `nghttp2_submit_window_update()`, this function returns the
+ * number of bytes less than actually received.
+ *
+ * If flow control is disabled for a connection, this function returns
+ * 0.
+ *
+ * This function returns -1 if it fails.
+ */
+int32_t nghttp2_session_get_effective_recv_data_length
+(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Returns the local (receive) window size for a connection. The local
+ * window size can be adjusted by
+ * `nghttp2_submit_window_update()`. This function takes into account
+ * that and returns effective window size.
+ *
+ * This function returns -1 if it fails.
+ */
+int32_t nghttp2_session_get_effective_local_window_size
+(nghttp2_session *session);
+
+/**
+ * @function
+ *
+ * Submits GOAWAY frame with the given |error_code|.
+ *
+ * This function should be called when the connection should be
+ * terminated after sending GOAWAY. If the remaining streams should be
+ * processed after GOAWAY, use `nghttp2_submit_goaway()` instead.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_session_fail_session(nghttp2_session *session,
+ nghttp2_error_code error_code);
+
+/**
+ * @function
+ *
+ * Performs post-process of HTTP Upgrade request. This function can be
+ * called from both client and server, but the behavior is very
+ * different in each other.
+ *
+ * If called from client side, the |settings_payload| must be the
+ * value sent in ``HTTP2-Settings`` header field and must be decoded
+ * by base64url decoder. The |settings_payloadlen| is the length of
+ * |settings_payload|. The |settings_payload| is unpacked and its
+ * setting values will be submitted using
+ * `nghttp2_submit_settings()`. This means that the client application
+ * code does not need to submit SETTINGS by itself. The stream with
+ * stream ID=1 is opened and the |stream_user_data| is used for its
+ * stream_user_data. The opened stream becomes half-closed (local)
+ * state.
+ *
+ * If called from server side, the |settings_payload| must be the
+ * value received in ``HTTP2-Settings`` header field and must be
+ * decoded by base64url decoder. The |settings_payloadlen| is the
+ * length of |settings_payload|. It is treated as if the SETTINGS
+ * frame with that payload is received. Thus, callback functions for
+ * the reception of SETTINGS frame will be invoked. The stream with
+ * stream ID=1 is opened. The |stream_user_data| is ignored. The
+ * opened stream becomes half-closed (remote).
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |settings_payload| is badly formed.
+ * :enum:`NGHTTP2_ERR_PROTO`
+ * The stream ID 1 is already used or closed; or is not available;
+ * or the |settings_payload| does not include both
+ * :enum:`NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS` and
+ * :enum:`NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE`.
+ */
+int nghttp2_session_upgrade(nghttp2_session *session,
+ const uint8_t *settings_payload,
+ size_t settings_payloadlen,
+ void *stream_user_data);
+
+/**
+ * @function
+ *
+ * Serializes the SETTINGS values |iv| in the |buf|. The size of the
+ * |buf| is specified by |buflen|. The number of entries in the |iv|
+ * array is given by |niv|. The required space in |buf| for the |niv|
+ * entries is ``8*niv`` bytes and if the given buffer is too small, an
+ * error is returned. This function is used mainly for creating a
+ * SETTINGS payload to be sent with the ``HTTP2-Settings`` header
+ * field in an HTTP Upgrade request. The data written in |buf| is NOT
+ * base64url encoded and the application is responsible for encoding.
+ *
+ * This function returns the number of bytes written in |buf|, or one
+ * of the following negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |iv| contains duplicate settings ID or invalid value.
+ *
+ * :enum:`NGHTTP2_ERR_INSUFF_BUFSIZE`
+ * The provided |buflen| size is too small to hold the output.
+ */
+ssize_t nghttp2_pack_settings_payload(uint8_t *buf,
+ size_t buflen,
+ const nghttp2_settings_entry *iv,
+ size_t niv);
+
+/**
+ * @function
+ *
+ * Returns string describing the |lib_error_code|. The
+ * |lib_error_code| must be one of the :enum:`nghttp2_error`.
+ */
+const char* nghttp2_strerror(int lib_error_code);
+
+/**
+ * @function
+ *
+ * Submits HEADERS frame and optionally one or more DATA frames.
+ *
+ * The |pri| is priority of this request. 0 is the highest priority
+ * value and :macro:`NGHTTP2_PRI_LOWEST` is the lowest value.
+ *
+ * The |nv| contains the name/value pairs. For i >= 0, ``nv[2*i]``
+ * contains a pointer to the name string and ``nv[2*i+1]`` contains a
+ * pointer to the value string. The one beyond last value must be
+ * ``NULL``. That is, if the |nv| contains N name/value pairs,
+ * ``nv[2*N]`` must be ``NULL``.
+ *
+ * HTTP/2.0 specification has requirement about header fields in the
+ * request HEADERS. See the specification for more details.
+ *
+ * This function creates copies of all name/value pairs in |nv|. It
+ * also lower-cases all names in |nv|.
+ *
+ * The string in |nv| must be NULL-terminated. Use
+ * `nghttp2_submit_request2()` if name/value pairs are not
+ * NULL-terminated strings.
+ *
+ * If |data_prd| is not ``NULL``, it provides data which will be sent
+ * in subsequent DATA frames. In this case, a method that allows
+ * request message bodies
+ * (http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9) must
+ * be specified with ``:method`` key in |nv| (e.g. ``POST``). This
+ * function does not take ownership of the |data_prd|. The function
+ * copies the members of the |data_prd|. If |data_prd| is ``NULL``,
+ * HEADERS have END_STREAM set. The |stream_user_data| is data
+ * associated to the stream opened by this request and can be an
+ * arbitrary pointer, which can be retrieved later by
+ * `nghttp2_session_get_stream_user_data()`.
+ *
+ * Since the library reorders the frames and tries to send the highest
+ * prioritized one first and the HTTP/2.0 specification requires the
+ * stream ID must be strictly increasing, the stream ID of this
+ * request cannot be known until it is about to sent. To know the
+ * stream ID of the request, the application can use
+ * :member:`nghttp2_session_callbacks.before_ctrl_send_callback`. This
+ * callback is called just before the frame is sent. For HEADERS
+ * frame, the argument frame has the stream ID assigned. Also since
+ * the stream is already opened,
+ * `nghttp2_session_get_stream_user_data()` can be used to get
+ * |stream_user_data| to identify which HEADERS we are processing.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |pri| is invalid; or the |nv| includes empty name or
+ * ``NULL`` value.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_request(nghttp2_session *session, int32_t pri,
+ const char **nv,
+ const nghttp2_data_provider *data_prd,
+ void *stream_user_data);
+
+/**
+ * @function
+ *
+ * Just like `nghttp2_submit_request()`, but this function takes the
+ * |nva|, which is an array of ``nghttp2_nv`` with |nvlen| elements,
+ * as name/value pairs. This function is useful if name/value pairs
+ * are not NULL-terminated strings.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |pri| is invalid; or the |nva| includes empty name or
+ * name which contains invalid characters.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_request2(nghttp2_session *session, int32_t pri,
+ const nghttp2_nv *nva, size_t nvlen,
+ const nghttp2_data_provider *data_prd,
+ void *stream_user_data);
+
+/**
+ * @function
+ *
+ * Submits response HEADERS frame and optionally one or more DATA
+ * frames against the stream |stream_id|.
+ *
+ * The |nv| contains the name/value pairs. For i >= 0, ``nv[2*i]``
+ * contains a pointer to the name string and ``nv[2*i+1]`` contains a
+ * pointer to the value string. The one beyond last value must be
+ * ``NULL``. That is, if the |nv| contains N name/value pairs,
+ * ``nv[2*N]`` must be ``NULL``.
+ *
+ * HTTP/2.0 specification has requirement about header fields in the
+ * response HEADERS. See the specification for more details.
+ *
+ * This function creates copies of all name/value pairs in |nv|. It
+ * also lower-cases all names in |nv|.
+ *
+ * If |data_prd| is not ``NULL``, it provides data which will be sent
+ * in subsequent DATA frames. This function does not take ownership
+ * of the |data_prd|. The function copies the members of the
+ * |data_prd|. If |data_prd| is ``NULL``, HEADERS will have
+ * END_STREAM flag set.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |nv| includes empty name or ``NULL`` value.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_response(nghttp2_session *session,
+ int32_t stream_id, const char **nv,
+ const nghttp2_data_provider *data_prd);
+
+/**
+ * @function
+ *
+ * Submits HEADERS frame. The |flags| is bitwise OR of the
+ * following values:
+ *
+ * * :enum:`NGHTTP2_FLAG_END_STREAM`
+ * * :enum:`NGHTTP2_FLAG_END_HEADERS`
+ * * :enum:`NGHTTP2_FLAG_PRIORITY`
+ *
+ * If |flags| includes :enum:`NGHTTP2_FLAG_END_STREAM`, this frame has
+ * END_STREAM flag set. The library does not support header
+ * continuation and the HEADERS frame always has
+ * :enum:`NGHTTP2_FLAG_END_HEADERS` flag set regardless of the |flags|
+ * value.
+ *
+ * If the |stream_id| is -1, this frame is assumed as request (i.e.,
+ * request HEADERS frame which opens new stream). In this case, the
+ * actual stream ID is assigned just before the frame is sent. For
+ * response, specify stream ID in |stream_id|.
+ *
+ * The |pri| is priority of this request.
+ *
+ * The |nv| contains the name/value pairs. For i >= 0, ``nv[2*i]``
+ * contains a pointer to the name string and ``nv[2*i+1]`` contains a
+ * pointer to the value string. The one beyond last value must be
+ * ``NULL``. That is, if the |nv| contains N name/value pairs,
+ * ``nv[2*N]`` must be ``NULL``.
+ *
+ * This function creates copies of all name/value pairs in |nv|. It
+ * also lower-cases all names in |nv|.
+ *
+ * The |stream_user_data| is a pointer to an arbitrary data which is
+ * associated to the stream this frame will open. Therefore it is only
+ * used if this frame opens streams, in other words, it changes stream
+ * state from idle or reserved to open.
+ *
+ * This function is low-level in a sense that the application code can
+ * specify flags directly. For usual HTTP request,
+ * `nghttp2_submit_request()` is useful.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |pri| is invalid; or the |nv| includes empty name or
+ * ``NULL`` value.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_headers(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id, int32_t pri, const char **nv,
+ void *stream_user_data);
+
+/**
+ * @function
+ *
+ * Submits one or more DATA frames to the stream |stream_id|. The
+ * data to be sent are provided by |data_prd|. If |flags| contains
+ * :enum:`NGHTTP2_FLAG_END_STREAM`, the last DATA frame has END_STREAM
+ * flag set.
+ *
+ * This function does not take ownership of the |data_prd|. The
+ * function copies the members of the |data_prd|.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_STREAM_CLOSED`
+ * The stream is already closed or does not exist.
+ */
+int nghttp2_submit_data(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id,
+ const nghttp2_data_provider *data_prd);
+
+/**
+ * @function
+ *
+ * Submits PRIORITY frame to change the priority of stream |stream_id|
+ * to the priority value |pri|.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |pri| is negative.
+ * :enum:`NGHTTP2_ERR_STREAM_CLOSED`
+ * The stream is already closed or does not exist.
+ */
+int nghttp2_submit_priority(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id, int32_t pri);
+
+/**
+ * @function
+ *
+ * Submits RST_STREAM frame to cancel/reject the stream |stream_id|
+ * with the error code |error_code|.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_rst_stream(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id,
+ nghttp2_error_code error_code);
+
+/**
+ * @function
+ *
+ * Stores local settings and submits SETTINGS frame. The |iv| is the
+ * pointer to the array of :type:`nghttp2_settings_entry`. The |niv|
+ * indicates the number of :type:`nghttp2_settings_entry`.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * This function does not take ownership of the |iv|. This function
+ * copies all the elements in the |iv|.
+ *
+ * While updating individual stream's local window size, if the window
+ * size becomes strictly larger than NGHTTP2_MAX_WINDOW_SIZE,
+ * RST_STREAM is issued against such a stream.
+ *
+ * SETTINGS with :enum:`NGHTTP2_FLAG_ACK` is automatically submitted
+ * by the library and application could not send it at its will.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |iv| contains invalid value (e.g., attempting to re-enable
+ * flow control).
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_settings(nghttp2_session *session, uint8_t flags,
+ const nghttp2_settings_entry *iv, size_t niv);
+
+
+/**
+ * @function
+ *
+ * Submits PUSH_PROMISE frame. The |flags| is currently ignored and
+ * the resulting PUSH_PROMISE frame always has
+ * :enum:`NGHTTP2_FLAG_END_PUSH_PROMISE` flag set due to the lack of
+ * header continuation support in the library.
+ *
+ * The |stream_id| must be client initiated stream ID.
+ *
+ * The |nv| contains the name/value pairs. For i >= 0, ``nv[2*i]``
+ * contains a pointer to the name string and ``nv[2*i+1]`` contains a
+ * pointer to the value string. The one beyond last value must be
+ * ``NULL``. That is, if the |nv| contains N name/value pairs,
+ * ``nv[2*N]`` must be ``NULL``.
+ *
+ * This function creates copies of all name/value pairs in |nv|. It
+ * also lower-cases all names in |nv|.
+ *
+ * Since the library reorders the frames and tries to send the highest
+ * prioritized one first and the HTTP/2.0 specification requires the
+ * stream ID must be strictly increasing, the promised stream ID
+ * cannot be known until it is about to sent. To know the promised
+ * stream ID, the application can use
+ * :member:`nghttp2_session_callbacks.before_frame_send_callback`. This
+ * callback is called just before the frame is sent. For PUSH_PROMISE
+ * frame, the argument frame has the promised stream ID assigned.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_INVALID_ARGUMENT`
+ * The |nv| includes empty name or ``NULL`` value.
+ * :enum:`NGHTTP2_ERR_STREAM_CLOSED`
+ * The stream is already closed or does not exist.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_push_promise(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id, const char **nv);
+
+/**
+ * @function
+ *
+ * Submits PING frame. You don't have to send PING back when you
+ * received PING frame. The library automatically submits PING frame
+ * in this case.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * If the |opaque_data| is non ``NULL``, then it should point to the 8
+ * bytes array of memory to specify opaque data to send with PING
+ * frame. If the |opaque_data| is ``NULL``, zero-cleared 8 bytes will
+ * be sent as opaque data.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_ping(nghttp2_session *session, uint8_t flags,
+ uint8_t *opaque_data);
+
+/**
+ * @function
+ *
+ * Submits GOAWAY frame with the error code |error_code|.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * If the |opaque_data| is not ``NULL`` and |opaque_data_len| is not
+ * zero, those data will be sent as additional debug data. The
+ * library makes a copy of the memory region pointed by |opaque_data|
+ * with the length |opaque_data_len|, so the caller does not need to
+ * keep this memory after the return of this function. If the
+ * |opaque_data_len| is 0, the |opaque_data| could be ``NULL``.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_goaway(nghttp2_session *session, uint8_t flags,
+ nghttp2_error_code error_code,
+ uint8_t *opaque_data, size_t opaque_data_len);
+
+/**
+ * @function
+ *
+ * Submits WINDOW_UPDATE frame.
+ *
+ * The |flags| is currently ignored and should be
+ * :enum:`NGHTTP2_FLAG_NONE`.
+ *
+ * If the |window_size_increment| is positive, the WINDOW_UPDATE with
+ * that value as window_size_increment is queued. If the
+ * |window_size_increment| is larger than the received bytes from the
+ * remote endpoint, the local window size is increased by that
+ * difference.
+ *
+ * If the |window_size_increment| is negative, the local window size
+ * is decreased by -|window_size_increment|. If
+ * :enum:`NGHTTP2_OPT_NO_AUTO_STREAM_WINDOW_UPDATE` (or
+ * :enum:`NGHTTP2_OPT_NO_AUTO_CONNECTION_WINDOW_UPDATE` if |stream_id|
+ * is 0) is not set and the library decided that the WINDOW_UPDATE
+ * should be submitted, then WINDOW_UPDATE is queued with the current
+ * received bytes count.
+ *
+ * If the |window_size_increment| is 0, the function does nothing and
+ * returns 0.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_FLOW_CONTROL`
+ * The local window size overflow or gets negative.
+ * :enum:`NGHTTP2_ERR_STREAM_CLOSED`
+ * The stream is already closed or does not exist.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_submit_window_update(nghttp2_session *session, uint8_t flags,
+ int32_t stream_id,
+ int32_t window_size_increment);
+
+/**
+ * @function
+ *
+ * Compares lhs->name with lhs->namelen bytes and rhs->name with
+ * rhs->namelen bytes. Returns negative integer if lhs->name is found
+ * to be less than rhs->name; or returns positive integer if lhs->name
+ * is found to be greater than rhs->name; or returns 0 otherwise.
+ */
+int nghttp2_nv_compare_name(const nghttp2_nv *lhs, const nghttp2_nv *rhs);
+
+/**
+ * @function
+ *
+ * A helper function for dealing with NPN in client side. The |in|
+ * contains server's protocol in preferable order. The format of |in|
+ * is length-prefixed and not null-terminated. For example,
+ * ``HTTP-draft-04/2.0`` and ``http/1.1`` stored in |in| like this::
+ *
+ * in[0] = 17
+ * in[1..17] = "HTTP-draft-04/2.0"
+ * in[18] = 8
+ * in[19..26] = "http/1.1"
+ * inlen = 27
+ *
+ * The selection algorithm is as follows:
+ *
+ * 1. If server's list contains ``HTTP-draft-04/2.0``, it is selected
+ * and returns 1. The following step is not taken.
+ *
+ * 2. If server's list contains ``http/1.1``, this function selects
+ * ``http/1.1`` and returns 0. The following step is not taken.
+ *
+ * 3. This function selects nothing and returns -1. (So called
+ * non-overlap case). In this case, |out| and |outlen| are left
+ * untouched.
+ *
+ * Selecting ``HTTP-draft-04/2.0`` means that ``HTTP-draft-04/2.0`` is
+ * written into |*out| and its length (which is 17) is
+ * assigned to |*outlen|.
+ *
+ * See http://technotes.googlecode.com/git/nextprotoneg.html for more
+ * details about NPN.
+ *
+ * To use this method you should do something like::
+ *
+ * static int select_next_proto_cb(SSL* ssl,
+ * unsigned char **out,
+ * unsigned char *outlen,
+ * const unsigned char *in,
+ * unsigned int inlen,
+ * void *arg)
+ * {
+ * int rv;
+ * rv = nghttp2_select_next_protocol(out, outlen, in, inlen);
+ * if(rv == 1) {
+ * ((MyType*)arg)->http2_selected = 1;
+ * }
+ * return SSL_TLSEXT_ERR_OK;
+ * }
+ * ...
+ * SSL_CTX_set_next_proto_select_cb(ssl_ctx, select_next_proto_cb, my_obj);
+ *
+ * Note that the HTTP/2.0 spec does use ALPN instead of NPN. This
+ * function is provided for transitional period before ALPN is got
+ * implemented in major SSL/TLS libraries.
+ *
+ */
+int nghttp2_select_next_protocol(unsigned char **out, unsigned char *outlen,
+ const unsigned char *in, unsigned int inlen);
+
+struct nghttp2_gzip;
+
+/**
+ * @struct
+ *
+ * The gzip stream to inflate data. The details of this structure are
+ * intentionally hidden from the public API.
+ */
+typedef struct nghttp2_gzip nghttp2_gzip;
+
+/**
+ * @function
+ *
+ * A helper function to set up a per request gzip stream to inflate data.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_GZIP`
+ * The initialization of gzip stream failed.
+ * :enum:`NGHTTP2_ERR_NOMEM`
+ * Out of memory.
+ */
+int nghttp2_gzip_inflate_new(nghttp2_gzip **inflater_ptr);
+
+/**
+ * @function
+ *
+ * Frees the inflate stream. The |inflater| may be ``NULL``.
+ */
+void nghttp2_gzip_inflate_del(nghttp2_gzip *inflater);
+
+/**
+ * @function
+ *
+ * Inflates data in |in| with the length |*inlen_ptr| and stores the
+ * inflated data to |out| which has allocated size at least
+ * |*outlen_ptr|. On return, |*outlen_ptr| is updated to represent
+ * the number of data written in |out|. Similarly, |*inlen_ptr| is
+ * updated to represent the number of input bytes processed.
+ *
+ * This function returns 0 if it succeeds, or one of the following
+ * negative error codes:
+ *
+ * :enum:`NGHTTP2_ERR_GZIP`
+ * The inflation of gzip stream failed.
+ *
+ * The example follows::
+ *
+ * void on_data_chunk_recv_callback(nghttp2_session *session,
+ * uint8_t flags,
+ * int32_t stream_id,
+ * const uint8_t *data, size_t len,
+ * void *user_data)
+ * {
+ * ...
+ * req = nghttp2_session_get_stream_user_data(session, stream_id);
+ * nghttp2_gzip *inflater = req->inflater;
+ * while(len > 0) {
+ * uint8_t out[MAX_OUTLEN];
+ * size_t outlen = MAX_OUTLEN;
+ * size_t tlen = len;
+ * int rv;
+ * rv = nghttp2_gzip_inflate(inflater, out, &outlen, data, &tlen);
+ * if(rv != 0) {
+ * nghttp2_submit_rst_stream(session, stream_id,
+ * NGHTTP2_INTERNAL_ERROR);
+ * break;
+ * }
+ * ... Do stuff ...
+ * data += tlen;
+ * len -= tlen;
+ * }
+ * ....
+ * }
+ */
+int nghttp2_gzip_inflate(nghttp2_gzip *inflater,
+ uint8_t *out, size_t *outlen_ptr,
+ const uint8_t *in, size_t *inlen_ptr);
+
+/**
+ * @function
+ *
+ * Returns a pointer to a nghttp2_info struct with version information about
+ * the run-time library in use. The |least_version| argument can be set to a
+ * 24 bit numerical value for the least accepted version number and if the
+ * condition is not met, this function will return a NULL. Pass in 0 to skip
+ * the version checking.
+ */
+nghttp2_info *nghttp2_version(int least_version);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* NGHTTP2_H */
++ Enter search terms or a module, class or function name. +
+/*
+ * nghttp2 - HTTP/2.0 C Library
+ *
+ * Copyright (c) 2012, 2013 Tatsuhiro Tsujikawa
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+#ifndef NGHTTP2VER_H
+#define NGHTTP2VER_H
+
+/**
+ * @macro
+ * Version number of the nghttp2 library release
+ */
+#define NGHTTP2_VERSION "0.2.0"
+
+/**
+ * @macro
+ * Numerical representation of the version number of the nghttp2 library
+ * release. This is a 24 bit number with 8 bits for major number, 8 bits
+ * for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.
+ */
+#define NGHTTP2_VERSION_NUM 0x000200
+
+#endif /* NGHTTP2VER_H */
++ Enter search terms or a module, class or function name. +
+This is an experimental implementation of Hypertext Transfer Protocol +version 2.0.
+We started to implement HTTP-draft-07/2.0 +(http://tools.ietf.org/html/draft-ietf-httpbis-http2-07) and the +header compression +(http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-04).
+The nghttp2 code base was forked from spdylay project.
+| Features | +HTTP-draft-07/2.0 | +
|---|---|
| :authority | +Done | +
| HPACK-draft-04 | +Done | +
| SETTINGS_HEADER_TABLE_SIZE | +Done | +
| SETTINGS_ENABLE_PUSH | +Done | +
| FRAME_SIZE_ERROR | +Done | +
| SETTINGS with ACK | +Done | +
| Header Continuation | ++ |
| ALPN | ++ |
The following endpoints are available to try out nghttp2 +implementation. These endpoints supports HTTP-draft-07/2.0 and +the earlier draft versions are not supporeted.
+https://106.186.112.116 (TLS + NPN)
+NPN offers HTTP-draft-07/2.0, spdy/3, spdy/2 and +http/1.1.
+Note: certificate is self-signed and a browser will show alert
+http://106.186.112.116 (Upgrade + Direct)
+The following packages are needed to build the library:
+To build and run the unit test programs, the following packages are +required:
+To build the documentation, you need to install:
+To build and run the application programs (nghttp, nghttpd and +nghttpx) in src directory, the following packages are +required:
+To enable SPDY protocol in the application program nghttpx, the +following packages are required:
+To enable -a option (getting linked assets from the downloaded +resource) in nghttp, the following packages are needed:
+The header compression test tools in hdtest directory require the +following package:
+If you are using Ubuntu 12.04, you need the following packages +installed:
+spdylay is not packaged in Ubuntu, so you need to build it yourself: +http://spdylay.sourceforge.net/
+Building from git is easy, but please be sure that at least autoconf 2.68 is +used:
+$ autoreconf -i
+$ automake
+$ autoconf
+$ ./configure
+$ make
+Note
+Documentation is still incomplete.
+To build documentation, run:
+$ make html
+The documents will be generated under doc/manual/html/.
+The generated documents will not be installed with make install.
+The online documentation is available at +http://tatsuhiro-t.github.io/nghttp2/
+The src directory contains HTTP/2.0 client, server and proxy programs.
+nghttp is a HTTP/2.0 client. It can connect to the HTTP/2.0 server +with prior knowledge, HTTP Upgrade and NPN TLS extension.
+It has verbose output mode for framing information. Here is sample +output from nghttp client:
+$ src/nghttp -vn https://localhost:8443
+[ 0.003] NPN select next protocol: the remote server offers:
+ * HTTP-draft-07/2.0
+ * spdy/3
+ * spdy/2
+ * http/1.1
+ NPN selected the protocol: HTTP-draft-07/2.0
+[ 0.005] send SETTINGS frame <length=16, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(7):65535]
+[ 0.006] send HEADERS frame <length=47, flags=0x05, stream_id=1>
+ ; END_STREAM | END_HEADERS
+ ; Open new stream
+ :authority: localhost:8443
+ :method: GET
+ :path: /
+ :scheme: https
+ accept: */*
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/0.1.0-DEV
+[ 0.006] recv SETTINGS frame <length=16, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(7):65535]
+[ 0.006] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.006] recv WINDOW_UPDATE frame <length=4, flags=0x00, stream_id=0>
+ (window_size_increment=1000000007)
+[ 0.006] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.006] recv HEADERS frame <length=132, flags=0x04, stream_id=1>
+ ; END_HEADERS
+ ; First response header
+ :status: 200
+ accept-ranges: bytes
+ content-encoding: gzip
+ content-length: 146
+ content-type: text/html
+ date: Sun, 27 Oct 2013 14:23:54 GMT
+ etag: "b1-4e5535a027780-gzip"
+ last-modified: Sun, 01 Sep 2013 14:34:22 GMT
+ server: Apache/2.4.6 (Debian)
+ vary: Accept-Encoding
+ via: 1.1 nghttpx
+[ 0.006] recv DATA frame <length=146, flags=0x00, stream_id=1>
+[ 0.006] recv DATA frame <length=0, flags=0x01, stream_id=1>
+ ; END_STREAM
+[ 0.007] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
+The HTTP Upgrade is performed like this:
+$ src/nghttp -vnu http://localhost:8080
+[ 0.000] HTTP Upgrade request
+GET / HTTP/1.1
+Host: localhost:8080
+Connection: Upgrade, HTTP2-Settings
+Upgrade: HTTP-draft-07/2.0
+HTTP2-Settings: AAAABAAAAGQAAAAHAAD__w
+Accept: */*
+User-Agent: nghttp2/0.1.0-DEV
+
+
+[ 0.000] HTTP Upgrade response
+HTTP/1.1 101 Switching Protocols
+Connection: Upgrade
+Upgrade: HTTP-draft-07/2.0
+
+
+[ 0.001] HTTP Upgrade success
+[ 0.001] send SETTINGS frame <length=16, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(7):65535]
+[ 0.001] recv SETTINGS frame <length=16, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(7):65535]
+[ 0.001] recv WINDOW_UPDATE frame <length=4, flags=0x00, stream_id=0>
+ (window_size_increment=1000000007)
+[ 0.001] recv HEADERS frame <length=121, flags=0x04, stream_id=1>
+ ; END_HEADERS
+ ; First response header
+ :status: 200
+ accept-ranges: bytes
+ content-length: 177
+ content-type: text/html
+ date: Sun, 27 Oct 2013 14:26:04 GMT
+ etag: "b1-4e5535a027780"
+ last-modified: Sun, 01 Sep 2013 14:34:22 GMT
+ server: Apache/2.4.6 (Debian)
+ vary: Accept-Encoding
+ via: 1.1 nghttpx
+[ 0.001] recv DATA frame <length=177, flags=0x00, stream_id=1>
+[ 0.001] recv DATA frame <length=0, flags=0x01, stream_id=1>
+ ; END_STREAM
+[ 0.001] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[ 0.001] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
+[ 0.001] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+nghttpd is static web server. It is single threaded and +multiplexes connections using non-blocking socket.
+By default, it uses SSL/TLS connection. Use --no-tls option to +disable it.
+nghttpd only accept the HTTP/2.0 connection via NPN or direct +HTTP/2.0 connection. No HTTP Upgrade is supported.
+Just like nghttp, it has verbose output mode for framing +information. Here is sample output from nghttpd server:
+$ src/nghttpd --no-tls -v 8080
+IPv4: listen on port 8080
+IPv6: listen on port 8080
+[id=1] [ 1.189] send SETTINGS frame <length=8, flags=0x00, stream_id=0>
+ (niv=1)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+[id=1] [ 1.191] recv SETTINGS frame <length=16, flags=0x00, stream_id=0>
+ (niv=2)
+ [SETTINGS_MAX_CONCURRENT_STREAMS(4):100]
+ [SETTINGS_INITIAL_WINDOW_SIZE(7):65535]
+[id=1] [ 1.191] recv HEADERS frame <length=47, flags=0x05, stream_id=1>
+ ; END_STREAM | END_HEADERS
+ ; Open new stream
+ :authority: localhost:8080
+ :method: GET
+ :path: /
+ :scheme: http
+ accept: */*
+ accept-encoding: gzip, deflate
+ user-agent: nghttp2/0.1.0-DEV
+[id=1] [ 1.192] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[id=1] [ 1.192] send HEADERS frame <length=70, flags=0x04, stream_id=1>
+ ; END_HEADERS
+ ; First response header
+ :status: 404
+ content-encoding: gzip
+ content-type: text/html; charset=UTF-8
+ date: Sun, 27 Oct 2013 14:27:53 GMT
+ server: nghttpd nghttp2/0.1.0-DEV
+[id=1] [ 1.192] send DATA frame <length=117, flags=0x00, stream_id=1>
+[id=1] [ 1.192] send DATA frame <length=0, flags=0x01, stream_id=1>
+ ; END_STREAM
+[id=1] [ 1.192] stream_id=1 closed
+[id=1] [ 1.192] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
+ ; ACK
+ (niv=0)
+[id=1] [ 1.192] recv GOAWAY frame <length=8, flags=0x00, stream_id=0>
+ (last_stream_id=0, error_code=NO_ERROR(0), opaque_data(0)=[])
+[id=1] [ 1.192] closed
+The nghttpx is a multi-threaded reverse proxy for +HTTP-draft-07/2.0, SPDY and HTTP/1.1. It has several operation modes:
+| Mode option | +Frontend | +Backend | +Note | +
|---|---|---|---|
| default mode | +HTTP/2.0, SPDY, HTTP/1.1 (TLS) | +HTTP/1.1 | +Reverse proxy | +
| --http2-proxy | +HTTP/2.0, SPDY, HTTP/1.1 (TLS) | +HTTP/1.1 | +SPDY proxy | +
| --http2-bridge | +HTTP/2.0, SPDY, HTTP/1.1 (TLS) | +HTTP/2.0 (TLS) | ++ |
| --client | +HTTP/2.0, HTTP/1.1 | +HTTP/2.0 (TLS) | ++ |
| --client-proxy | +HTTP/2.0, HTTP/1.1 | +HTTP/2.0 (TLS) | +Forward proxy | +
The interesting mode at the moment is the default mode. It works like +a reverse proxy and listens HTTP-draft-07/2.0, SPDY and HTTP/1.1 and +can be deployed SSL/TLS terminator for existing web server.
+The default mode, --http2-proxy and --http2-bridge modes use +SSL/TLS in the frontend connection by default. To disable SSL/TLS, use +--frontend-no-tls option. If that option is used, SPDY is disabled +in the frontend and incoming HTTP/1.1 connection can be upgraded to +HTTP/2.0 through HTTP Upgrade.
+The --http2-bridge, --client and --client-proxy modes use +SSL/TLS in the backend connection by deafult. To disable SSL/TLS, use +--backend-no-tls option.
+The nghttpx supports configuration file. See --conf option and +sample configuration file nghttpx.conf.sample.
+In the default mode, (without any of --http2-proxy, +--http2-bridge, --client-proxy and --client options), +nghttpx works as reverse proxy to the backend server:
+Client <-- (HTTP/2.0, SPDY, HTTP/1.1) --> nghttpx <-- (HTTP/1.1) --> Web Server
+ [reverse proxy]
+With --http2-proxy option, it works as so called secure proxy (aka +SPDY proxy):
+Client <-- (HTTP/2.0, SPDY, HTTP/1.1) --> nghttpx <-- (HTTP/1.1) --> Proxy
+ [secure proxy] (e.g., Squid)
+The Client in the above is needs to be configured to use +nghttpx as secure proxy.
+At the time of this writing, Chrome is the only browser which supports +secure proxy. The one way to configure Chrome to use secure proxy is +create proxy.pac script like this:
+function FindProxyForURL(url, host) {
+ return "HTTPS SERVERADDR:PORT";
+}
+SERVERADDR and PORT is the hostname/address and port of the +machine nghttpx is running. Please note that Chrome requires valid +certificate for secure proxy.
+Then run chrome with the following arguments:
+$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
+With --http2-bridge, it accepts HTTP/2.0, SPDY and HTTP/1.1 +connections and communicates with backend in HTTP/2.0:
+Client <-- (HTTP/2.0, SPDY, HTTP/1.1) --> nghttpx <-- (HTTP/2.0) --> Web or HTTP/2.0 Proxy etc
+ (e.g., nghttpx -s)
+With --client-proxy option, it works as forward proxy and expects +that the backend is HTTP/2.0 proxy:
+Client <-- (HTTP/2.0, HTTP/1.1) --> nghttpx <-- (HTTP/2.0) --> HTTP/2.0 Proxy
+ [forward proxy] (e.g., nghttpx -s)
+The Client is needs to be configured to use nghttpx as forward +proxy. The frontend HTTP/1.1 connection can be upgraded to HTTP/2.0 +through HTTP Upgrade. With the above configuration, one can use +HTTP/1.1 client to access and test their HTTP/2.0 servers.
+With --client option, it works as reverse proxy and expects that +the backend is HTTP/2.0 Web server:
+Client <-- (HTTP/2.0, HTTP/1.1) --> nghttpx <-- (HTTP/2.0) --> Web Server
+ [reverse proxy]
+The frontend HTTP/1.1 connection can be upgraded to HTTP/2.0 +through HTTP Upgrade.
+For the operation modes which talk to the backend in HTTP/2.0 over +SSL/TLS, the backend connections can be tunneled though HTTP +proxy. The proxy is specified using --backend-http-proxy-uri +option. The following figure illustrates the example of +--http2-bridge and --backend-http-proxy-uri option to talk to +the outside HTTP/2.0 proxy through HTTP proxy:
+Client <-- (HTTP/2.0, SPDY, HTTP/1.1) --> nghttpx <-- (HTTP/2.0) --
+
+ --===================---> HTTP/2.0 Proxy
+ (HTTP proxy tunnel) (e.g., nghttpx -s)
+The hdtest directory contains header compression test tools. The +deflatehd is command-line header compression tool. The +inflatehd is command-line header decompression tool. Both tools +read input from stdin and write output to stdout. The errors are +written to stderr. They take JSON as input and output.
+The deflatehd reads JSON array or HTTP/1-style header fields from +stdin and outputs compressed header block in JSON array.
+For the JSON input, the element of input array must be a JSON +object. Each object must have at least following key:
+Example:
+[
+ {
+ "headers": [
+ [ ":method", "GET" ],
+ [ ":path", "/" ]
+ ]
+ },
+ {
+ "headers": [
+ [ ":method", "POST" ],
+ [ ":path", "/" ]
+ ]
+ }
+]
+These header sets are processed in the order they appear in the JSON +outer most array using same compression context.
+With -t option, the program can accept more familiar HTTP/1 style +header field block. Each header set is delimited by empty line:
+Example:
+:method: GET
+:scheme: https
+:path: /
+
+:method: POST
+user-agent: nghttp2
+The output is a JSON array and each element is JSON object, which has +at least following keys:
+Examples:
+[
+ {
+ "seq": 0,
+ "inputLen": 66,
+ "outputLength": 20,
+ "percentageOfOriginalSize": 30.303030303030305,
+ "output": "818703881f3468e5891afcbf863c856659c62e3f"
+ },
+ {
+ "seq": 1,
+ "inputLen": 74,
+ "outputLength": 10,
+ "percentageOfOriginalSize": 13.513513513513514,
+ "output": "87038504252dd5918386"
+ }
+]
+The output can be used as the input for inflatehd.
+With -d option, the extra headerTable key is added and its +associated value contains the state of dyanmic header table after the +corresponding header set was processed. The value contains following +keys:
+Example:
+[
+ {
+ "seq": 0,
+ "inputLen": 66,
+ "outputLength": 20,
+ "percentageOfOriginalSize": 30.303030303030305,
+ "output": "818703881f3468e5891afcbf863c856659c62e3f",
+ "headerTable": {
+ "entries": [
+ {
+ "index": 0,
+ "name": "user-agent",
+ "value": "nghttp2",
+ "referenced": true,
+ "size": 49
+ },
+ {
+ "index": 1,
+ "name": ":path",
+ "value": "/",
+ "referenced": true,
+ "size": 38
+ },
+ {
+ "index": 2,
+ "name": ":authority",
+ "value": "example.org",
+ "referenced": true,
+ "size": 53
+ },
+ {
+ "index": 3,
+ "name": ":scheme",
+ "value": "https",
+ "referenced": true,
+ "size": 44
+ },
+ {
+ "index": 4,
+ "name": ":method",
+ "value": "GET",
+ "referenced": true,
+ "size": 42
+ }
+ ],
+ "size": 226,
+ "maxSize": 4096,
+ "deflateSize": 226,
+ "maxDeflateSize": 4096
+ }
+ },
+ {
+ "seq": 1,
+ "inputLen": 74,
+ "outputLength": 10,
+ "percentageOfOriginalSize": 13.513513513513514,
+ "output": "87038504252dd5918386",
+ "headerTable": {
+ "entries": [
+ {
+ "index": 0,
+ "name": ":path",
+ "value": "/account",
+ "referenced": true,
+ "size": 45
+ },
+ {
+ "index": 1,
+ "name": ":method",
+ "value": "POST",
+ "referenced": true,
+ "size": 43
+ },
+ {
+ "index": 2,
+ "name": "user-agent",
+ "value": "nghttp2",
+ "referenced": true,
+ "size": 49
+ },
+ {
+ "index": 3,
+ "name": ":path",
+ "value": "/",
+ "referenced": false,
+ "size": 38
+ },
+ {
+ "index": 4,
+ "name": ":authority",
+ "value": "example.org",
+ "referenced": true,
+ "size": 53
+ },
+ {
+ "index": 5,
+ "name": ":scheme",
+ "value": "https",
+ "referenced": true,
+ "size": 44
+ },
+ {
+ "index": 6,
+ "name": ":method",
+ "value": "GET",
+ "referenced": false,
+ "size": 42
+ }
+ ],
+ "size": 314,
+ "maxSize": 4096,
+ "deflateSize": 314,
+ "maxDeflateSize": 4096
+ }
+ }
+]
+The inflatehd reads JSON array from stdin and outputs decompressed +name/value pairs in JSON array. The element of input array must be a +JSON object. Each object must have at least following key:
+Example:
+[
+ { "output": "0284f77778ff" },
+ { "output": "0185fafd3c3c7f81" }
+]
+The output is a JSON array and each element is JSON object, which has +at least following keys:
+Example:
+[
+ {
+ "seq": 0,
+ "headers": [
+ [":authority", "example.org"],
+ [":method", "GET"],
+ [":path", "/"],
+ [":scheme", "https"],
+ ["user-agent", "nghttp2"]
+ ]
+ },
+ {
+ "seq": 1,
+ "headers": [
+ [":authority", "example.org"],
+ [":method", "POST"],
+ [":path", "/account"],
+ [":scheme", "https"],
+ ["user-agent", "nghttp2"]
+ ]
+ }
+]
+The output can be used as the input for deflatehd.
+With -d option, the extra headerTable key is added and its +associated value contains the state of dyanmic header table after the +corresponding header set was processed. The format is the same as +deflatehd.
++ Enter search terms or a module, class or function name. +
++ Please activate JavaScript to enable the search + functionality. +
++ From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +
+ + +