From 9eb29ab43e49391af6b393861aac2bd28a7fe0e7 Mon Sep 17 00:00:00 2001 From: Wu Jian Gang Date: Wed, 28 Sep 2016 13:50:34 +0800 Subject: [PATCH] components/nghttp: just change format of nghttp.rst preview will be better. --- components/nghttp/nghttp.rst | 40 ++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/components/nghttp/nghttp.rst b/components/nghttp/nghttp.rst index 77988a2a7f..21dd697bff 100644 --- a/components/nghttp/nghttp.rst +++ b/components/nghttp/nghttp.rst @@ -1,39 +1,39 @@ The nghttp Instruction ============================= - + This is an implementation of the Hypertext Transfer Protocol version 2 in C. The framing layer of HTTP/2 is implemented as a reusable C library. An HPACK encoder and decoder are available as a public API. -- The nghttp support many different processor, but for the most part you only need the following functions: +- The nghttp support many different processor, but for the most part you only need the following functions: - *nghttp2_session_callbacks_new:* Initializes *callbacks_ptr with NULL values + **nghttp2_session_callbacks_new**: Initializes \*callbacks_ptr with NULL values - *nghttp2_session_client_new:* Initializes *session_ptr for client use + **nghttp2_session_client_new**: Initializes \*session_ptr for client use - *nghttp2_session_callbacks_del:* Frees any resources allocated for callbacks + **nghttp2_session_callbacks_del**: Frees any resources allocated for callbacks + + **nghttp2_submit_settings**: Stores local settings and submits SETTINGS frame + + **nghttp2_submit_request**: Submits HEADERS frame and optionally one or more DATA frames + + **nghttp2_session_want_read**: Returns nonzero value if session wants to receive data from the remote peer + + **nghttp2_session_want_write**: Returns nonzero value if session wants to send data to the remote peer + + **nghttp2_session_recv**: Receives frames from the remote peer + + **nghttp2_session_send**: Sends pending frames to the remote peer + + **nghttp2_session_del**: Frees any resources allocated for session - *nghttp2_submit_settings:* Stores local settings and submits SETTINGS frame - - *nghttp2_submit_request:* Submits HEADERS frame and optionally one or more DATA frames - - *nghttp2_session_want_read:* Returns nonzero value if session wants to receive data from the remote peer - - *nghttp2_session_want_write:* Returns nonzero value if session wants to send data to the remote peer - - *nghttp2_session_recv:* Receives frames from the remote peer - - *nghttp2_session_send:* Sends pending frames to the remote peer - - *nghttp2_session_del:* Frees any resources allocated for session - If you are following TLS related RFC, you know that NPN is not the standardized way to negotiate HTTP/2. NPN itself is not even published as RFC. The standard way to negotiate HTTP/2 is ALPN, Application-Layer Protocol Negotiation Extension, defined in RFC 7301. -- The following endpoints are available to try out the nghttp2 implementation: +- The following endpoints are available to try out the nghttp2 implementation: https://nghttp2.org/ (TLS + ALPN/NPN)