walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

altsvc: Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2016-04-09 19:20:07 +09:00
parent d4144a7475
commit 3086d65657
2 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/sources/index.rst
View File

@ -51,3 +51,4 @@ Resources
* HTTP/2 https://tools.ietf.org/html/rfc7540 * HTTP/2 https://tools.ietf.org/html/rfc7540
* HPACK https://tools.ietf.org/html/rfc7541 * HPACK https://tools.ietf.org/html/rfc7541
* HTTP Alternative Services https://tools.ietf.org/html/rfc7838

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

@ -593,7 +593,8 @@ typedef enum {
*/ */
NGHTTP2_CONTINUATION = 0x09, NGHTTP2_CONTINUATION = 0x09,
/** /**
* The ALTSVC frame. * The ALTSVC frame, which is defined in `RFC 7383
* <https://tools.ietf.org/html/rfc7838#section-4>`_.
*/ */
NGHTTP2_ALTSVC = 0x0a NGHTTP2_ALTSVC = 0x0a
} nghttp2_frame_type; } nghttp2_frame_type;
@ -2378,7 +2379,7 @@ nghttp2_option_set_user_recv_extension_type(nghttp2_option *option,
uint8_t type); uint8_t type);
/** /**
* @ function * @function
* *
* Sets extension frame type the application is willing to receive * Sets extension frame type the application is willing to receive
* using builtin handler. The |type| is the extension frame type to * using builtin handler. The |type| is the extension frame type to
@ -4140,8 +4141,8 @@ NGHTTP2_EXTERN int nghttp2_submit_extension(nghttp2_session *session,
/** /**
* @struct * @struct
* *
* The payload of ALTSVC frame. ALTSVC frame is one of extension * The payload of ALTSVC frame. ALTSVC frame is a non-critical
* frame. If this frame is received, and * extension to HTTP/2. If this frame is received, and
* `nghttp2_option_set_user_recv_extension_type()` is not set, and * `nghttp2_option_set_user_recv_extension_type()` is not set, and
* `nghttp2_option_set_builtin_recv_extension_type()` is set for * `nghttp2_option_set_builtin_recv_extension_type()` is set for
* :enum:`NGHTTP2_ALTSVC`, ``nghttp2_extension.payload`` will point to * :enum:`NGHTTP2_ALTSVC`, ``nghttp2_extension.payload`` will point to
@ -4150,9 +4151,23 @@ NGHTTP2_EXTERN int nghttp2_submit_extension(nghttp2_session *session,
* It has the following members: * It has the following members:
*/ */
typedef struct { typedef struct {
/**
* The pointer to origin which this alternative service is
* associated with. This is not necessarily NULL-terminated.
*/
uint8_t *origin; uint8_t *origin;
/**
* The length of the |origin|.
*/
size_t origin_len; size_t origin_len;
/**
* The pointer to Alt-Svc field value contained in ALTSVC frame.
* This is not necessarily NULL-terminated.
*/
uint8_t *field_value; uint8_t *field_value;
/**
* The length of the |field_value|.
*/
size_t field_value_len; size_t field_value_len;
} nghttp2_ext_altsvc; } nghttp2_ext_altsvc;
@ -4161,6 +4176,10 @@ typedef struct {
* *
* Submits ALTSVC frame. * Submits ALTSVC frame.
* *
* ALTSVC frame is a non-critical extension to HTTP/2, and defined in
* is defined in `RFC 7383
* <https://tools.ietf.org/html/rfc7838#section-4>`_.
*
* The |flags| is currently ignored and should be * The |flags| is currently ignored and should be
* :enum:`NGHTTP2_FLAG_NONE`. * :enum:`NGHTTP2_FLAG_NONE`.
* *