components/nghttp: just change format of nghttp.rst

preview will be better.
This commit is contained in:
Wu Jian Gang 2016-09-28 13:50:34 +08:00
parent 89bc31e158
commit 9eb29ab43e

View File

@ -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)