Skip to content

N
nghttp2
Commit c6d958c9 authored by Tatsuhiro Tsujikawa's avatar Tatsuhiro Tsujikawa
Browse files
Options

First pages commit

parents
Hide whitespace changes
Inline Side-by-side
Showing with 7048 additions and 0 deletions
_sources/apiref.txt 0 → 100644
View file @ c6d958c9
API Reference
=============
Includes
--------
To use the public APIs, include ``nghttp2/nghttp2.h``::
#include <nghttp2/nghttp2.h>
Remarks
-------
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.
Macros
------
.. macro:: NGHTTP2_VERSION
Version number of the nghttp2 library release
.. macro:: NGHTTP2_PROTO_VERSION_ID
The protocol version identification of this library supports.
.. macro:: NGHTTP2_PROTO_VERSION_ID_LEN
The length of NGHTTP2_PROTO_VERSION_ID.
.. macro:: NGHTTP2_PRI_DEFAULT
The default priority value
.. macro:: NGHTTP2_PRI_LOWEST
The lowest priority value
.. macro:: NGHTTP2_INITIAL_WINDOW_SIZE
The initial window size for stream level flow control.
.. macro:: NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE
The initial window size for connection level flow control.
.. macro:: NGHTTP2_CLIENT_CONNECTION_HEADER
The client connection header.
.. macro:: NGHTTP2_CLIENT_CONNECTION_HEADER_LEN
The length of NGHTTP2_CLIENT_CONNECTION_HEADER.
.. macro:: NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS
Default maximum concurrent streams.
Enums
-----
.. type:: nghttp2_error
Error codes used in this library. The code range is [-999, -500],
inclusive. The following values are defined:
.. macro:: NGHTTP2_ERR_INVALID_ARGUMENT
(``-501``)
Invalid argument passed.
.. macro:: NGHTTP2_ERR_UNSUPPORTED_VERSION
(``-503``)
The specified protocol version is not supported.
.. macro:: NGHTTP2_ERR_WOULDBLOCK
(``-504``)
Used as a return value from :type:`nghttp2_send_callback` and
:type:`nghttp2_recv_callback` to indicate that the operation
would block.
.. macro:: NGHTTP2_ERR_PROTO
(``-505``)
General protocol error
.. macro:: NGHTTP2_ERR_INVALID_FRAME
(``-506``)
The frame is invalid.
.. macro:: NGHTTP2_ERR_EOF
(``-507``)
The peer performed a shutdown on the connection.
.. macro:: NGHTTP2_ERR_DEFERRED
(``-508``)
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.
.. macro:: NGHTTP2_ERR_STREAM_ID_NOT_AVAILABLE
(``-509``)
Stream ID has reached the maximum value. Therefore no stream ID
is available.
.. macro:: NGHTTP2_ERR_STREAM_CLOSED
(``-510``)
The stream is already closed; or the stream ID is invalid.
.. macro:: NGHTTP2_ERR_STREAM_CLOSING
(``-511``)
RST_STREAM has been added to the outbound queue. The stream is in
closing state.
.. macro:: NGHTTP2_ERR_STREAM_SHUT_WR
(``-512``)
The transmission is not allowed for this stream (e.g., a frame
with END_STREAM flag set has already sent).
.. macro:: NGHTTP2_ERR_INVALID_STREAM_ID
(``-513``)
The stream ID is invalid.
.. macro:: NGHTTP2_ERR_INVALID_STREAM_STATE
(``-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).
.. macro:: NGHTTP2_ERR_DEFERRED_DATA_EXIST
(``-515``)
Another DATA frame has already been deferred.
.. macro:: NGHTTP2_ERR_START_STREAM_NOT_ALLOWED
(``-516``)
Starting new stream is not allowed. (e.g., GOAWAY has been sent
and/or received.
.. macro:: NGHTTP2_ERR_GOAWAY_ALREADY_SENT
(``-517``)
GOAWAY has already been sent.
.. macro:: NGHTTP2_ERR_INVALID_HEADER_BLOCK
(``-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).
.. macro:: NGHTTP2_ERR_INVALID_STATE
(``-519``)
Indicates that the context is not suitable to perform the
requested operation.
.. macro:: NGHTTP2_ERR_GZIP
(``-520``)
The gzip error.
.. macro:: NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE
(``-521``)
The user callback function failed due to the temporal error.
.. macro:: NGHTTP2_ERR_FRAME_TOO_LARGE
(``-522``)
The length of the frame is too large.
.. macro:: NGHTTP2_ERR_HEADER_COMP
(``-523``)
Header block inflate/deflate error.
.. macro:: NGHTTP2_ERR_FATAL
(``-900``)
The errors < :macro:`NGHTTP2_ERR_FATAL` mean that the library is
under unexpected condition and cannot process any further data
reliably (e.g., out of memory).
.. macro:: NGHTTP2_ERR_NOMEM
(``-901``)
Out of memory. This is a fatal error.
.. macro:: NGHTTP2_ERR_CALLBACK_FAILURE
(``-902``)
The user callback function failed. This is a fatal error.
.. type:: nghttp2_frame_type
The control frame types in HTTP/2.0.
.. macro:: NGHTTP2_DATA
(``0``)
The DATA frame.
.. macro:: NGHTTP2_HEADERS
(``1``)
The HEADERS frame.
.. macro:: NGHTTP2_PRIORITY
(``2``)
The PRIORITY frame.
.. macro:: NGHTTP2_RST_STREAM
(``3``)
The RST_STREAM frame.
.. macro:: NGHTTP2_SETTINGS
(``4``)
The SETTINGS frame.
.. macro:: NGHTTP2_PUSH_PROMISE
(``5``)
The PUSH_PROMISE frame.
.. macro:: NGHTTP2_PING
(``6``)
The PING frame.
.. macro:: NGHTTP2_GOAWAY
(``7``)
The GOAWAY frame.
.. macro:: NGHTTP2_WINDOW_UPDATE
(``9``)
The WINDOW_UPDATE frame.
.. type:: nghttp2_flag
The flags for HTTP/2.0 frames. This enum defines all flags for
frames, assuming that the same flag name has the same mask.
.. macro:: NGHTTP2_FLAG_NONE
(``0``)
No flag set.
.. macro:: NGHTTP2_FLAG_END_STREAM
(``0x1``)
The END_STREAM flag.
.. macro:: NGHTTP2_FLAG_END_HEADERS
(``0x4``)
The END_HEADERS flag.
.. macro:: NGHTTP2_FLAG_PRIORITY
(``0x8``)
The PRIORITY flag.
.. macro:: NGHTTP2_FLAG_END_PUSH_PROMISE
(``0x1``)
The END_PUSH_PROMISE flag.
.. macro:: NGHTTP2_FLAG_PONG
(``0x1``)
The PONG flag.
.. macro:: NGHTTP2_FLAG_END_FLOW_CONTROL
(``0x1``)
The END_FLOW_CONTROL flag.
.. type:: nghttp2_settings_id
The SETTINGS ID.
.. macro:: NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS
(``4``)
SETTINGS_MAX_CONCURRENT_STREAMS
.. macro:: NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE
(``7``)
SETTINGS_INITIAL_WINDOW_SIZE
.. macro:: NGHTTP2_SETTINGS_FLOW_CONTROL_OPTIONS
(``10``)
SETTINGS_FLOW_CONTROL_OPTIONS
.. macro:: NGHTTP2_SETTINGS_MAX
(``10``)
Maximum ID of :type:`nghttp2_settings_id`.
.. type:: nghttp2_error_code
The status codes for the RST_STREAM and GOAWAY frames.
.. macro:: NGHTTP2_NO_ERROR
(``0``)
No errors.
.. macro:: NGHTTP2_PROTOCOL_ERROR
(``1``)
PROTOCOL_ERROR
.. macro:: NGHTTP2_INTERNAL_ERROR
(``2``)
INTERNAL_ERROR
.. macro:: NGHTTP2_FLOW_CONTROL_ERROR
(``3``)
FLOW_CONTROL_ERROR
.. macro:: NGHTTP2_STREAM_CLOSED
(``5``)
STREAM_CLOSED
.. macro:: NGHTTP2_FRAME_TOO_LARGE
(``6``)
FRAME_TOO_LARGE
.. macro:: NGHTTP2_REFUSED_STREAM
(``7``)
REFUSED_STREAM
.. macro:: NGHTTP2_CANCEL
(``8``)
CANCEL
.. macro:: NGHTTP2_COMPRESSION_ERROR
(``9``)
COMPRESSION_ERROR
.. type:: nghttp2_headers_category
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.
.. macro:: NGHTTP2_HCAT_REQUEST
(``0``)
The HEADERS frame is opening new stream, which is analogous to
SYN_STREAM in SPDY.
.. macro:: NGHTTP2_HCAT_RESPONSE
(``1``)
The HEADERS frame is the first response headers, which is
analogous to SYN_REPLY in SPDY.
.. macro:: NGHTTP2_HCAT_PUSH_RESPONSE
(``2``)
The HEADERS frame is the first headers sent against reserved
stream.
.. macro:: NGHTTP2_HCAT_HEADERS
(``3``)
The HEADERS frame which does not apply for the above categories,
which is analogous to HEADERS in SPDY.
.. type:: nghttp2_opt
Configuration options for :type:`nghttp2_session`.
.. macro:: NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE
(``1``)
This option prevents the library from sending WINDOW_UPDATE
automatically. If this option is set, the application is
responsible for sending WINDOW_UPDATE using
`nghttp2_submit_window_update`.
Types (structs, unions and typedefs)
------------------------------------
.. type:: nghttp2_session
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.
.. type:: nghttp2_nv
The name/value pair, which mainly used to represent header fields.
.. member:: uint8_t *name
The *name* byte string, which is not necessarily NULL terminated.
.. member:: uint8_t *value
The *value* byte string, which is not necessarily NULL
terminated.
.. member:: uint16_t namelen
The length of the *name*.
.. member:: uint16_t valuelen
The length of the *value*.
.. type:: nghttp2_frame_hd
The frame header.
.. member:: uint16_t length
The length field of this frame, excluding frame header.
.. member:: uint8_t type
The type of this frame. See `nghttp2_frame`.
.. member:: uint8_t flags
The flags.
.. member:: int32_t stream_id
The stream identifier (aka, stream ID)
.. type:: nghttp2_data_source
This union represents the some kind of data source passed to
:type:`nghttp2_data_source_read_callback`.
.. member:: int fd
The integer field, suitable for a file descriptor.
.. member:: void *ptr
The pointer to an arbitrary object.
.. type:: 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)
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 :macro:`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
:macro:`NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE` will close the stream
by issuing RST_STREAM with :macro:`NGHTTP2_INTERNAL_ERROR`.
Returning :macro:`NGHTTP2_ERR_CALLBACK_FAILURE` will signal the
entire session failure.
.. type:: nghttp2_data_provider
This struct represents the data source and the way to read a chunk
of data from it.
.. member:: nghttp2_data_source source
The data source.
.. member:: nghttp2_data_source_read_callback read_callback
The callback function to read a chunk of data from the *source*.
.. type:: nghttp2_headers
The HEADERS frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: int32_t pri
The priority.
.. member:: nghttp2_nv *nva
The name/value pairs.
.. member:: size_t nvlen
The number of name/value pairs in *nva*.
.. type:: nghttp2_priority
The PRIORITY frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: int32_t pri
The priority.
.. type:: nghttp2_rst_stream
The RST_STREAM frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: nghttp2_error_code error_code
The error code. See :type:`nghttp2_error_code`.
.. type:: nghttp2_settings_entry
The SETTINGS ID/Value pair. It has the following members:
.. member:: int32_t settings_id
The SETTINGS ID. See :type:`nghttp2_settings_id`.
.. member:: uint32_t value
The value of this entry.
.. type:: nghttp2_settings
The SETTINGS frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: size_t niv
The number of SETTINGS ID/Value pairs in *iv*.
.. member:: nghttp2_settings_entry *iv
The pointer to the array of SETTINGS ID/Value pair.
.. type:: nghttp2_push_promise
The PUSH_PROMISE frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: int32_t promised_stream_id
The promised stream ID
.. member:: nghttp2_nv *nva
The name/value pairs.
.. member:: size_t nvlen
The number of name/value pairs in *nva*.
.. type:: nghttp2_ping
The PING frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: uint8_t opaque_data[8]
The opaque data
.. type:: nghttp2_goaway
The GOAWAY frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: int32_t last_stream_id
The last stream stream ID.
.. member:: nghttp2_error_code error_code
The error code. See :type:`nghttp2_error_code`.
.. member:: uint8_t *opaque_data
The additional debug data
.. member:: size_t opaque_data_len
The length of *opaque_data* member.
.. type:: nghttp2_window_update
The WINDOW_UPDATE frame. It has the following members:
.. member:: nghttp2_frame_hd hd
The frame header.
.. member:: int32_t window_size_increment
The window size increment.
.. type:: nghttp2_mem_chunk
The structure to hold chunk of memory.
TODO Drop this if it is not used anymore.
.. member:: uint8_t *data
The pointer to the data.
.. member:: size_t length
The length of the data.
.. type:: nghttp2_frame
This union includes all frames to pass them to various function
calls as nghttp2_frame type. The DATA frame is intentionally
omitted from here.
.. member:: nghttp2_frame_hd hd
The frame header, which is convenient to inspect frame header.
.. member:: nghttp2_headers headers
The HEADERS frame.
.. member:: nghttp2_priority priority
The PRIORITY frame.
.. member:: nghttp2_rst_stream rst_stream
The RST_STREAM frame.
.. member:: nghttp2_settings settings
The SETTINGS frame.
.. member:: nghttp2_push_promise push_promise
The PUSH_PROMISE frame.
.. member:: nghttp2_ping ping
The PING frame.
.. member:: nghttp2_goaway goaway
The GOAWAY frame.
.. member:: nghttp2_window_update window_update
The WINDOW_UPDATE frame.
.. type:: typedef ssize_t (*nghttp2_send_callback) (nghttp2_session *session, const uint8_t *data, size_t length, int flags, void *user_data)
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 :macro:`NGHTTP2_ERR_WOULDBLOCK`. For other errors, it
must return :macro:`NGHTTP2_ERR_CALLBACK_FAILURE`.
.. type:: typedef ssize_t (*nghttp2_recv_callback) (nghttp2_session *session, uint8_t *buf, size_t length, int flags, void *user_data)
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 :macro:`NGHTTP2_ERR_WOULDBLOCK`. If
it gets EOF before it reads any single byte, it must return
:macro:`NGHTTP2_ERR_EOF`. For other errors, it must return
:macro:`NGHTTP2_ERR_CALLBACK_FAILURE`.
.. type:: typedef void (*nghttp2_on_frame_recv_callback) (nghttp2_session *session, nghttp2_frame *frame, void *user_data)
Callback function invoked by `nghttp2_session_recv()` when a
non-DATA frame is received.
.. type:: typedef void (*nghttp2_on_invalid_frame_recv_callback) (nghttp2_session *session, nghttp2_frame *frame, nghttp2_error_code error_code, void *user_data)
Callback function invoked by `nghttp2_session_recv()` when an
invalid non-DATA frame is received. The *error_code* is one of the
:macro:`nghttp2_error_code` and indicates the error. When this
callback function is invoked, the library automatically submits
either RST_STREAM or GOAWAY frame.
.. type:: typedef void (*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)
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.
.. type:: typedef void (*nghttp2_on_data_recv_callback) (nghttp2_session *session, uint16_t length, uint8_t flags, int32_t stream_id, void *user_data)
Callback function invoked when DATA frame is received. The actual
data it contains are received by
:type:`nghttp2_on_data_chunk_recv_callback`.
.. type:: typedef void (*nghttp2_before_frame_send_callback) (nghttp2_session *session, nghttp2_frame *frame, void *user_data)
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.
.. type:: typedef void (*nghttp2_on_frame_send_callback) (nghttp2_session *session, nghttp2_frame *frame, void *user_data)
Callback function invoked after the non-DATA frame *frame* is sent.
.. type:: typedef void (*nghttp2_on_frame_not_send_callback) (nghttp2_session *session, nghttp2_frame *frame, int lib_error_code, void *user_data)
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`.
.. type:: typedef void (*nghttp2_on_data_send_callback) (nghttp2_session *session, uint16_t length, uint8_t flags, int32_t stream_id, void *user_data)
Callback function invoked after DATA frame is sent.
.. type:: typedef void (*nghttp2_on_stream_close_callback) (nghttp2_session *session, int32_t stream_id, nghttp2_error_code error_code, void *user_data)
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.
.. type:: typedef void (*nghttp2_on_request_recv_callback) (nghttp2_session *session, int32_t stream_id, void *user_data)
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.
.. type:: typedef void (*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)
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 :macro:`nghttp2_error` and indicates the error.
.. type:: typedef void (*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)
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.
.. type:: nghttp2_session_callbacks
Callback functions.
.. member:: nghttp2_send_callback send_callback
Callback function invoked when the *session* wants to send data
to the remote peer.
.. member:: nghttp2_recv_callback recv_callback
Callback function invoked when the *session* wants to receive
data from the remote peer.
.. member:: nghttp2_on_frame_recv_callback on_frame_recv_callback
Callback function invoked by `nghttp2_session_recv()` when a
non-DATA frame is received.
.. member:: nghttp2_on_invalid_frame_recv_callback on_invalid_frame_recv_callback
Callback function invoked by `nghttp2_session_recv()` when an
invalid non-DATA frame is received.
.. member:: nghttp2_on_data_chunk_recv_callback on_data_chunk_recv_callback
Callback function invoked when a chunk of data in DATA frame is
received.
.. member:: nghttp2_on_data_recv_callback on_data_recv_callback
Callback function invoked when DATA frame is received.
.. member:: nghttp2_before_frame_send_callback before_frame_send_callback
Callback function invoked before the non-DATA frame is sent.
.. member:: nghttp2_on_frame_send_callback on_frame_send_callback
Callback function invoked after the non-DATA frame is sent.
.. member:: nghttp2_on_frame_not_send_callback on_frame_not_send_callback
The callback function invoked when a non-DATA frame is not sent
because of an error.
.. member:: nghttp2_on_data_send_callback on_data_send_callback
Callback function invoked after DATA frame is sent.
.. member:: nghttp2_on_stream_close_callback on_stream_close_callback
Callback function invoked when the stream is closed.
.. member:: nghttp2_on_request_recv_callback on_request_recv_callback
Callback function invoked when request from the remote peer is
received.
.. member:: nghttp2_on_frame_recv_parse_error_callback
Callback function invoked when the received non-DATA frame octets
could not be parsed correctly.
.. member:: nghttp2_on_unknown_frame_recv_callback on_unknown_frame_recv_callback
Callback function invoked when the received frame type is
unknown.
.. type:: nghttp2_gzip
The gzip stream to inflate data. The details of this structure are
intentionally hidden from the public API.
Functions
---------
.. function:: int nghttp2_session_client_new(nghttp2_session **session_ptr, const nghttp2_session_callbacks *callbacks, void *user_data)
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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_session_server_new(nghttp2_session **session_ptr, const nghttp2_session_callbacks *callbacks, void *user_data)
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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: void nghttp2_session_del(nghttp2_session *session)
Frees any resources allocated for *session*. If *session* is
``NULL``, this function does nothing.
.. function:: int nghttp2_session_set_option(nghttp2_session *session, int optname, void *optval, size_t optlen)
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:
:macro:`NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE`
The *optval* must be a pointer to ``int``. If the *\*optval* is
nonzero, the library will not send WINDOW_UPDATE automatically.
Therefore, the application is responsible for sending
WINDOW_UPDATE using `nghttp2_submit_window_update`. This option
defaults to 0.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *optname* is not supported; or the *optval* and/or the
*optlen* are invalid.
.. function:: int nghttp2_session_send(nghttp2_session *session)
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
:macro:`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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
:macro:`NGHTTP2_ERR_CALLBACK_FAILURE`
The callback function failed.
.. function:: int nghttp2_session_recv(nghttp2_session *session)
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
:macro:`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:
:macro:`NGHTTP2_ERR_EOF`
The remote peer did shutdown on the connection.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
:macro:`NGHTTP2_ERR_CALLBACK_FAILURE`
The callback function failed.
.. function:: ssize_t nghttp2_session_mem_recv(nghttp2_session *session, const uint8_t *in, size_t inlen)
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 an error occurs.
This function returns the number of processed bytes, or one of the
following negative error codes:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_session_resume_data(nghttp2_session *session, int32_t stream_id)
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:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The stream does not exist or no deferred data exist.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_session_want_read(nghttp2_session *session)
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.
.. function:: int nghttp2_session_want_write(nghttp2_session *session)
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.
.. function:: void* nghttp2_session_get_stream_user_data(nghttp2_session *session, int32_t stream_id)
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``.
.. function:: size_t nghttp2_session_get_outbound_queue_size(nghttp2_session *session)
Returns the number of frames in the outbound queue. This does not
include the deferred DATA frames.
.. function:: int nghttp2_session_fail_session(nghttp2_session *session, nghttp2_error_code error_code)
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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: const char* nghttp2_strerror(int lib_error_code)
Returns string describing the *lib_error_code*. The
*lib_error_code* must be one of the :macro:`nghttp2_error`.
.. function:: int nghttp2_submit_request(nghttp2_session *session, int32_t pri, const char **nv, const nghttp2_data_provider *data_prd, void *stream_user_data)
Submits HEADERS frame and optionally one or more DATA frames.
The *pri* is priority of this request. 0 is the highest priority
value. Use `nghttp2_session_get_pri_lowest()` to know the lowest
priority value for this *session*.
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``.
The *nv* must include following name/value pairs:
``:method``
HTTP method (e.g., ``GET``, ``POST``, ``HEAD``, etc)
``:scheme``
URI scheme (e.g., ``https``)
``:path``
Absolute path and parameters of this request (e.g., ``/foo``,
``/foo;bar;haz?h=j&y=123``)
``:host``
The hostport portion of the URI for this request (e.g.,
``example.org:443``). This is the same as the HTTP "Host" header
field.
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. 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:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is invalid; or the *nv* includes empty name or NULL
value.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_response(nghttp2_session *session, int32_t stream_id, const char **nv, const nghttp2_data_provider *data_prd)
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``.
The *nv* must include following name/value pairs:
``:status``
HTTP status code (e.g., ``200`` or ``200 OK``)
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:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *nv* includes empty name or NULL value.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_headers(nghttp2_session *session, uint8_t flags, int32_t stream_id, int32_t pri, const char **nv, void *stream_user_data)
Submits HEADERS frame. The *flags* is bitwise OR of the
following values:
* :macro:`NGHTTP2_FLAG_END_STREAM`
* :macro:`NGHTTP2_FLAG_PRIORITY`
If *flags* includes :macro:`NGHTTP2_FLAG_END_STREAM`, this frame has
END_STREAM flag set.
If the *stream_id* is -1, this frame is assumed as request (i.e.,
first 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 and the Associated-To-Stream-ID 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:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is invalid; or the *assoc_stream_id* is invalid; or
the *nv* includes empty name or NULL value.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_data(nghttp2_session *session, uint8_t flags, int32_t stream_id, const nghttp2_data_provider *data_prd)
Submits one or more DATA frames to the stream *stream_id*. The
data to be sent are provided by *data_prd*. If *flags* contains
:macro:`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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_priority(nghttp2_session *session, int32_t stream_id, int32_t pri)
Submits PRIORITY frame to change the priority of stream *stream_id*
to the priority value *pri*.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *pri* is negative.
.. function:: int nghttp2_submit_rst_stream(nghttp2_session *session, int32_t stream_id, nghttp2_error_code error_code)
Submits RST_STREAM frame to cancel/reject the stream *stream_id*
with the error code *error_code*.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_settings(nghttp2_session *session, const nghttp2_settings_entry *iv, size_t niv)
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 bitwise-OR of one or more values from
:type:`nghttp2_settings_flag`.
This function does not take ownership of the *iv*. This function
copies all the elements in the *iv*.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *iv* contains duplicate settings ID or invalid value.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_push_promise(nghttp2_session *session, uint8_t flags, int32_t stream_id, const char **nv)
Submits PUSH_PROMISE frame. The *flags* is currently ignored.
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_ctrl_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:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *nv* includes empty name or NULL value.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_ping(nghttp2_session *session, uint8_t *opaque_data)
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.
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, 8 zero bytes will be sent as
opaque data.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_goaway(nghttp2_session *session, nghttp2_error_code error_code, uint8_t *opaque_data, size_t opaque_data_len)
Submits GOAWAY frame with the error code *error_code*.
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:
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_submit_window_update(nghttp2_session *session, uint8_t flags, int32_t stream_id, int32_t window_size_increment)
Submits WINDOW_UPDATE frame. The effective range of the
*window_size_increment* is [1, (1 << 31)-1], inclusive. But the
application must be responsible to keep the resulting window size
<= (1 << 31)-1. If NGHTTP2_FLAG_END_FLOW_CONTROL bit set in the
*flags*, 0 can be specified in the *window_size_increment*. In
fact, if this flag is set, the value specified in the
*window_size_increment* is ignored.
This function returns 0 if it succeeds, or one of the following
negative error codes:
:macro:`NGHTTP2_ERR_INVALID_ARGUMENT`
The *delta_window_size* is 0 or negative if
NGHTTP2_FLAG_END_FLOW_CONTROL bit is not set in *flags*.
:macro:`NGHTTP2_ERR_STREAM_CLOSED`
The stream is already closed or does not exist.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: int nghttp2_select_next_protocol(unsigned char **out, unsigned char *outlen, const unsigned char *in, unsigned int inlen)
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.
.. function:: int nghttp2_gzip_inflate_new(nghttp2_gzip **inflater_ptr)
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:
:macro:`NGHTTP2_ERR_GZIP`
The initialization of gzip stream failed.
:macro:`NGHTTP2_ERR_NOMEM`
Out of memory.
.. function:: void nghttp2_gzip_inflate_del(nghttp2_gzip *inflater)
Frees the inflate stream. The *inflater* may be ``NULL``.
.. function:: int nghttp2_gzip_inflate(nghttp2_gzip *inflater, uint8_t *out, size_t *outlen_ptr, const uint8_t *in, size_t *inlen_ptr)
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:
:macro:`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;
}
....
}
_sources/index.txt 0 → 100644
View file @ c6d958c9
.. nghttp2 documentation master file, created by
sphinx-quickstart on Sun Mar 11 22:57:49 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
nghttp2 - HTTP/2.0 C Library
============================
This is an experimental implementation of Hypertext Transfer Protocol
version 2.0.
Contents:
.. toctree::
:maxdepth: 2
package_README
apiref
Resources
---------
* http://tools.ietf.org/html/draft-ietf-httpbis-http2-04
_sources/package_README.txt 0 → 100644
View file @ c6d958c9
.. include:: ../README.rst
_static/basic.css 0 → 100644
View file @ c6d958c9
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}
div.sphinxsidebar #searchbox input[type="submit"] {
width: 30px;
}
img {
border: 0;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.field-list ul {
padding-left: 1em;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
}
p.sidebar-title {
font-weight: bold;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
div.admonition dl {
margin-bottom: 0;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
dl {
margin-bottom: 15px;
}
dd p {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dt:target, .highlighted {
background-color: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.refcount {
color: #060;
}
.optional {
font-size: 1.3em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
td.linenos pre {
padding: 5px 0px;
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
margin-left: 0.5em;
}
table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}
tt.descclassname {
background-color: transparent;
}
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}
\ No newline at end of file
_static/default.css 0 → 100644
View file @ c6d958c9
/*
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: roboto, sans-serif;
font-size: 100%;
background-color: none;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: none;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #444;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #444;
text-decoration: underline;
}
div.related {
background-color: #fff;
line-height: 30px;
color: #444;
}
div.related a {
color: #444;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: roboto, "Trebuchet MS", sans-serif;
color: #444;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar h4 {
font-family: roboto, "Trebuchet MS", sans-serif;
color: #444;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #444;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #444;
}
div.sphinxsidebar a {
color: #444;
}
div.sphinxsidebar input {
border: 1px solid #444;
font-family: sans-serif;
font-size: 1em;
}
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: roboto, "Trebuchet MS", sans-serif;
background-color: none;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: roboto, sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
\ No newline at end of file
_static/default2.css 0 → 100644
View file @ c6d958c9
@import url(http://fonts.googleapis.com/css?family=Roboto:400,400italic,500,500italic);
pre, tt {
font-family: monospace, sans-serif;
}
tt {
font-size: 100%;
}
div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6 {
border: 0;
margin: 0;
padding: 0.3em 0;
}
_static/doctools.js 0 → 100644
View file @ c6d958c9
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*/
jQuery.urldecode = function(x) {
return decodeURIComponent(x).replace(/\+/g, ' ');
}
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s == 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* small function to check if an array contains
* a given item.
*/
jQuery.contains = function(arr, item) {
for (var i = 0; i < arr.length; i++) {
if (arr[i] == item)
return true;
}
return false;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node) {
if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
var span = document.createElement("span");
span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this);
});
}
}
return this.each(function() {
highlight(this);
});
};
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated == 'undefined')
return string;
return (typeof translated == 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated == 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.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();
});
_static/jquery.js 0 → 100644
View file @ c6d958c9
This source diff could not be displayed because it is too large. You can view the blob instead.
_static/pygments.css 0 → 100644
View file @ c6d958c9
.highlight .hll { background-color: #ffffcc }
.highlight { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #333333 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
_static/searchtools.js 0 → 100644
View file @ c6d958c9
/*
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilties for the full-text search.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
jQuery.makeSearchSummary = function(text, keywords, hlwords) {
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null, success: null,
dataType: "script", cache: true});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (var i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p style="display: none"></p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
query : function(query) {
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
// Stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = query.split(/\s+/);
var objectterms = [];
for (var i = 0; i < tmp.length; i++) {
if (tmp[i] != "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) ||
tmp[i] == "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i]).toLowerCase();
// select the correct list
if (word[0] == '-') {
var toAppend = excluded;
word = word.substr(1);
}
else {
var toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$.contains(toAppend, word))
toAppend.push(word);
};
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var filenames = this._index.filenames;
var titles = this._index.titles;
var terms = this._index.terms;
var fileMap = {};
var files = null;
// different result priorities
var importantResults = [];
var objectResults = [];
var regularResults = [];
var unimportantResults = [];
$('#search-progress').empty();
// lookup as object
for (var i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0,i),
objectterms.slice(i+1, objectterms.length))
var results = this.performObjectSearch(objectterms[i], others);
// Assume first word is most likely to be the object,
// other words more likely to be in description.
// Therefore put matches for earlier words first.
// (Results are eventually used in reverse order).
objectResults = results[0].concat(objectResults);
importantResults = results[1].concat(importantResults);
unimportantResults = results[2].concat(unimportantResults);
}
// perform the search on the required terms
for (var i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
// no match but word was a required one
if ((files = terms[word]) == null)
break;
if (files.length == undefined) {
files = [files];
}
// create the mapping
for (var j = 0; j < files.length; j++) {
var file = files[j];
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (var file in fileMap) {
var valid = true;
// check if all requirements are matched
if (fileMap[file].length != searchterms.length)
continue;
// ensure that none of the excluded terms is in the
// search result.
for (var i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
$.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it
// to the result list
if (valid)
regularResults.push([filenames[file], titles[file], '', null]);
}
// delete unused variables in order to not waste
// memory until list is retrieved completely
delete filenames, titles, terms;
// now sort the regular results descending by title
regularResults.sort(function(a, b) {
var left = a[1].toLowerCase();
var right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
});
// combine all results
var results = unimportantResults.concat(regularResults)
.concat(objectResults).concat(importantResults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' +
item[0] + '.txt', function(data) {
if (data != '') {
listItem.append($.makeSearchSummary(data, searchterms, hlterms));
Search.output.append(listItem);
}
listItem.slideDown(5, function() {
displayNextItem();
});
}, "text");
} else {
// no source available, just display title
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
},
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var importantResults = [];
var objectResults = [];
var unimportantResults = [];
for (var prefix in objects) {
for (var name in objects[prefix]) {
var fullname = (prefix ? prefix + '.' : '') + name;
if (fullname.toLowerCase().indexOf(object) > -1) {
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (var i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
anchor = match[3];
if (anchor == '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
result = [filenames[match[0]], fullname, '#'+anchor, descr];
switch (match[2]) {
case 1: objectResults.push(result); break;
case 0: importantResults.push(result); break;
case 2: unimportantResults.push(result); break;
}
}
}
}
// sort results descending
objectResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
importantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
unimportantResults.sort(function(a, b) {
return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0);
});
return [importantResults, objectResults, unimportantResults]
}
}
$(document).ready(function() {
Search.init();
});
\ No newline at end of file
_static/sidebar.js 0 → 100644
View file @ c6d958c9
/*
* sidebar.js
* ~~~~~~~~~~
*
* This script makes the Sphinx sidebar collapsible.
*
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
* used to collapse and expand the sidebar.
*
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
* and the width of the sidebar and the margin-left of the document
* are decreased. When the sidebar is expanded the opposite happens.
* This script saves a per-browser/per-session cookie used to
* remember the position of the sidebar among the pages.
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
$(function() {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function
var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// for some reason, the document has no sidebar; do not run into errors
if (!sidebar.length) return;
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');
var ssb_width_expanded = sidebar.width();
// margin-left of the bodywrapper and width of the sidebar
// with the sidebar collapsed
var bw_margin_collapsed = '.8em';
var ssb_width_collapsed = '.8em';
// colors used by the current theme
var dark_color = $('.related').css('background-color');
var light_color = $('.document').css('background-color');
function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)');
}
function toggle_sidebar() {
if (sidebar_is_collapsed())
expand_sidebar();
else
collapse_sidebar();
}
function collapse_sidebar() {
sidebarwrapper.hide();
sidebar.css('width', ssb_width_collapsed);
bodywrapper.css('margin-left', bw_margin_collapsed);
sidebarbutton.css({
'margin-left': '0',
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('»');
sidebarbutton.attr('title', _('Expand sidebar'));
document.cookie = 'sidebar=collapsed';
}
function expand_sidebar() {
bodywrapper.css('margin-left', bw_margin_expanded);
sidebar.css('width', ssb_width_expanded);
sidebarwrapper.show();
sidebarbutton.css({
'margin-left': ssb_width_expanded-12,
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('«');
sidebarbutton.attr('title', _('Collapse sidebar'));
document.cookie = 'sidebar=expanded';
}
function add_sidebar_button() {
sidebarwrapper.css({
'float': 'left',
'margin-right': '0',
'width': ssb_width_expanded - 28
});
// create the button
sidebar.append(
'<div id="sidebarbutton"><span>&laquo;</span></div>'
);
var sidebarbutton = $('#sidebarbutton');
light_color = sidebarbutton.css('background-color');
// find the height of the viewport to center the '<<' in the page
var viewport_height;
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
sidebarbutton.find('span').css({
'display': 'block',
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
});
sidebarbutton.click(toggle_sidebar);
sidebarbutton.attr('title', _('Collapse sidebar'));
sidebarbutton.css({
'color': '#FFFFFF',
'border-left': '1px solid ' + dark_color,
'font-size': '1.2em',
'cursor': 'pointer',
'height': bodywrapper.height(),
'padding-top': '1px',
'margin-left': ssb_width_expanded - 12
});
sidebarbutton.hover(
function () {
$(this).css('background-color', dark_color);
},
function () {
$(this).css('background-color', light_color);
}
);
}
function set_position_from_cookie() {
if (!document.cookie)
return;
var items = document.cookie.split(';');
for(var k=0; k<items.length; k++) {
var key_val = items[k].split('=');
var key = key_val[0];
if (key == 'sidebar') {
var value = key_val[1];
if ((value == 'collapsed') && (!sidebar_is_collapsed()))
collapse_sidebar();
else if ((value == 'expanded') && (sidebar_is_collapsed()))
expand_sidebar();
}
}
}
add_sidebar_button();
var sidebarbutton = $('#sidebarbutton');
set_position_from_cookie();
});
_static/underscore.js 0 → 100644
View file @ c6d958c9
// Underscore.js 1.4.4
// http://underscorejs.org
// (c) 2009-2013 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore may be freely distributed under the MIT license.
(function() {
// Baseline setup
// --------------
// Establish the root object, `window` in the browser, or `global` on the server.
var root = this;
// Save the previous value of the `_` variable.
var previousUnderscore = root._;
// Establish the object that gets returned to break out of a loop iteration.
var breaker = {};
// Save bytes in the minified (but not gzipped) version:
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
// Create quick reference variables for speed access to core prototypes.
var push = ArrayProto.push,
slice = ArrayProto.slice,
concat = ArrayProto.concat,
toString = ObjProto.toString,
hasOwnProperty = ObjProto.hasOwnProperty;
// All **ECMAScript 5** native function implementations that we hope to use
// are declared here.
var
nativeForEach = ArrayProto.forEach,
nativeMap = ArrayProto.map,
nativeReduce = ArrayProto.reduce,
nativeReduceRight = ArrayProto.reduceRight,
nativeFilter = ArrayProto.filter,
nativeEvery = ArrayProto.every,
nativeSome = ArrayProto.some,
nativeIndexOf = ArrayProto.indexOf,
nativeLastIndexOf = ArrayProto.lastIndexOf,
nativeIsArray = Array.isArray,
nativeKeys = Object.keys,
nativeBind = FuncProto.bind;
// Create a safe reference to the Underscore object for use below.
var _ = function(obj) {
if (obj instanceof _) return obj;
if (!(this instanceof _)) return new _(obj);
this._wrapped = obj;
};
// Export the Underscore object for **Node.js**, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `_` as a global object via a string identifier,
// for Closure Compiler "advanced" mode.
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {
root._ = _;
}
// Current version.
_.VERSION = '1.4.4';
// Collection Functions
// --------------------
// The cornerstone, an `each` implementation, aka `forEach`.
// Handles objects with the built-in `forEach`, arrays, and raw objects.
// Delegates to **ECMAScript 5**'s native `forEach` if available.
var each = _.each = _.forEach = function(obj, iterator, context) {
if (obj == null) return;
if (nativeForEach && obj.forEach === nativeForEach) {
obj.forEach(iterator, context);
} else if (obj.length === +obj.length) {
for (var i = 0, l = obj.length; i < l; i++) {
if (iterator.call(context, obj[i], i, obj) === breaker) return;
}
} else {
for (var key in obj) {
if (_.has(obj, key)) {
if (iterator.call(context, obj[key], key, obj) === breaker) return;
}
}
}
};
// Return the results of applying the iterator to each element.
// Delegates to **ECMAScript 5**'s native `map` if available.
_.map = _.collect = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
each(obj, function(value, index, list) {
results[results.length] = iterator.call(context, value, index, list);
});
return results;
};
var reduceError = 'Reduce of empty array with no initial value';
// **Reduce** builds up a single result from a list of values, aka `inject`,
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduce && obj.reduce === nativeReduce) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
}
each(obj, function(value, index, list) {
if (!initial) {
memo = value;
initial = true;
} else {
memo = iterator.call(context, memo, value, index, list);
}
});
if (!initial) throw new TypeError(reduceError);
return memo;
};
// The right-associative version of reduce, also known as `foldr`.
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
}
var length = obj.length;
if (length !== +length) {
var keys = _.keys(obj);
length = keys.length;
}
each(obj, function(value, index, list) {
index = keys ? keys[--length] : --length;
if (!initial) {
memo = obj[index];
initial = true;
} else {
memo = iterator.call(context, memo, obj[index], index, list);
}
});
if (!initial) throw new TypeError(reduceError);
return memo;
};
// Return the first value which passes a truth test. Aliased as `detect`.
_.find = _.detect = function(obj, iterator, context) {
var result;
any(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) {
result = value;
return true;
}
});
return result;
};
// Return all the elements that pass a truth test.
// Delegates to **ECMAScript 5**'s native `filter` if available.
// Aliased as `select`.
_.filter = _.select = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
each(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) results[results.length] = value;
});
return results;
};
// Return all the elements for which a truth test fails.
_.reject = function(obj, iterator, context) {
return _.filter(obj, function(value, index, list) {
return !iterator.call(context, value, index, list);
}, context);
};
// Determine whether all of the elements match a truth test.
// Delegates to **ECMAScript 5**'s native `every` if available.
// Aliased as `all`.
_.every = _.all = function(obj, iterator, context) {
iterator || (iterator = _.identity);
var result = true;
if (obj == null) return result;
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
each(obj, function(value, index, list) {
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
});
return !!result;
};
// Determine if at least one element in the object matches a truth test.
// Delegates to **ECMAScript 5**'s native `some` if available.
// Aliased as `any`.
var any = _.some = _.any = function(obj, iterator, context) {
iterator || (iterator = _.identity);
var result = false;
if (obj == null) return result;
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
each(obj, function(value, index, list) {
if (result || (result = iterator.call(context, value, index, list))) return breaker;
});
return !!result;
};
// Determine if the array or object contains a given value (using `===`).
// Aliased as `include`.
_.contains = _.include = function(obj, target) {
if (obj == null) return false;
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
return any(obj, function(value) {
return value === target;
});
};
// Invoke a method (with arguments) on every item in a collection.
_.invoke = function(obj, method) {
var args = slice.call(arguments, 2);
var isFunc = _.isFunction(method);
return _.map(obj, function(value) {
return (isFunc ? method : value[method]).apply(value, args);
});
};
// Convenience version of a common use case of `map`: fetching a property.
_.pluck = function(obj, key) {
return _.map(obj, function(value){ return value[key]; });
};
// Convenience version of a common use case of `filter`: selecting only objects
// containing specific `key:value` pairs.
_.where = function(obj, attrs, first) {
if (_.isEmpty(attrs)) return first ? null : [];
return _[first ? 'find' : 'filter'](obj, function(value) {
for (var key in attrs) {
if (attrs[key] !== value[key]) return false;
}
return true;
});
};
// Convenience version of a common use case of `find`: getting the first object
// containing specific `key:value` pairs.
_.findWhere = function(obj, attrs) {
return _.where(obj, attrs, true);
};
// Return the maximum element or (element-based computation).
// Can't optimize arrays of integers longer than 65,535 elements.
// See: https://bugs.webkit.org/show_bug.cgi?id=80797
_.max = function(obj, iterator, context) {
if (!iterator && _.isArray(obj) && obj[0] === +obj[0] && obj.length < 65535) {
return Math.max.apply(Math, obj);
}
if (!iterator && _.isEmpty(obj)) return -Infinity;
var result = {computed : -Infinity, value: -Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed >= result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Return the minimum element (or element-based computation).
_.min = function(obj, iterator, context) {
if (!iterator && _.isArray(obj) && obj[0] === +obj[0] && obj.length < 65535) {
return Math.min.apply(Math, obj);
}
if (!iterator && _.isEmpty(obj)) return Infinity;
var result = {computed : Infinity, value: Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed < result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Shuffle an array.
_.shuffle = function(obj) {
var rand;
var index = 0;
var shuffled = [];
each(obj, function(value) {
rand = _.random(index++);
shuffled[index - 1] = shuffled[rand];
shuffled[rand] = value;
});
return shuffled;
};
// An internal function to generate lookup iterators.
var lookupIterator = function(value) {
return _.isFunction(value) ? value : function(obj){ return obj[value]; };
};
// Sort the object's values by a criterion produced by an iterator.
_.sortBy = function(obj, value, context) {
var iterator = lookupIterator(value);
return _.pluck(_.map(obj, function(value, index, list) {
return {
value : value,
index : index,
criteria : iterator.call(context, value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria;
var b = right.criteria;
if (a !== b) {
if (a > b || a === void 0) return 1;
if (a < b || b === void 0) return -1;
}
return left.index < right.index ? -1 : 1;
}), 'value');
};
// An internal function used for aggregate "group by" operations.
var group = function(obj, value, context, behavior) {
var result = {};
var iterator = lookupIterator(value || _.identity);
each(obj, function(value, index) {
var key = iterator.call(context, value, index, obj);
behavior(result, key, value);
});
return result;
};
// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
_.groupBy = function(obj, value, context) {
return group(obj, value, context, function(result, key, value) {
(_.has(result, key) ? result[key] : (result[key] = [])).push(value);
});
};
// Counts instances of an object that group by a certain criterion. Pass
// either a string attribute to count by, or a function that returns the
// criterion.
_.countBy = function(obj, value, context) {
return group(obj, value, context, function(result, key) {
if (!_.has(result, key)) result[key] = 0;
result[key]++;
});
};
// Use a comparator function to figure out the smallest index at which
// an object should be inserted so as to maintain order. Uses binary search.
_.sortedIndex = function(array, obj, iterator, context) {
iterator = iterator == null ? _.identity : lookupIterator(iterator);
var value = iterator.call(context, obj);
var low = 0, high = array.length;
while (low < high) {
var mid = (low + high) >>> 1;
iterator.call(context, array[mid]) < value ? low = mid + 1 : high = mid;
}
return low;
};
// Safely convert anything iterable into a real, live array.
_.toArray = function(obj) {
if (!obj) return [];
if (_.isArray(obj)) return slice.call(obj);
if (obj.length === +obj.length) return _.map(obj, _.identity);
return _.values(obj);
};
// Return the number of elements in an object.
_.size = function(obj) {
if (obj == null) return 0;
return (obj.length === +obj.length) ? obj.length : _.keys(obj).length;
};
// Array Functions
// ---------------
// Get the first element of an array. Passing **n** will return the first N
// values in the array. Aliased as `head` and `take`. The **guard** check
// allows it to work with `_.map`.
_.first = _.head = _.take = function(array, n, guard) {
if (array == null) return void 0;
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
};
// Returns everything but the last entry of the array. Especially useful on
// the arguments object. Passing **n** will return all the values in
// the array, excluding the last N. The **guard** check allows it to work with
// `_.map`.
_.initial = function(array, n, guard) {
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
};
// Get the last element of an array. Passing **n** will return the last N
// values in the array. The **guard** check allows it to work with `_.map`.
_.last = function(array, n, guard) {
if (array == null) return void 0;
if ((n != null) && !guard) {
return slice.call(array, Math.max(array.length - n, 0));
} else {
return array[array.length - 1];
}
};
// Returns everything but the first entry of the array. Aliased as `tail` and `drop`.
// Especially useful on the arguments object. Passing an **n** will return
// the rest N values in the array. The **guard**
// check allows it to work with `_.map`.
_.rest = _.tail = _.drop = function(array, n, guard) {
return slice.call(array, (n == null) || guard ? 1 : n);
};
// Trim out all falsy values from an array.
_.compact = function(array) {
return _.filter(array, _.identity);
};
// Internal implementation of a recursive `flatten` function.
var flatten = function(input, shallow, output) {
each(input, function(value) {
if (_.isArray(value)) {
shallow ? push.apply(output, value) : flatten(value, shallow, output);
} else {
output.push(value);
}
});
return output;
};
// Return a completely flattened version of an array.
_.flatten = function(array, shallow) {
return flatten(array, shallow, []);
};
// Return a version of the array that does not contain the specified value(s).
_.without = function(array) {
return _.difference(array, slice.call(arguments, 1));
};
// Produce a duplicate-free version of the array. If the array has already
// been sorted, you have the option of using a faster algorithm.
// Aliased as `unique`.
_.uniq = _.unique = function(array, isSorted, iterator, context) {
if (_.isFunction(isSorted)) {
context = iterator;
iterator = isSorted;
isSorted = false;
}
var initial = iterator ? _.map(array, iterator, context) : array;
var results = [];
var seen = [];
each(initial, function(value, index) {
if (isSorted ? (!index || seen[seen.length - 1] !== value) : !_.contains(seen, value)) {
seen.push(value);
results.push(array[index]);
}
});
return results;
};
// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
_.union = function() {
return _.uniq(concat.apply(ArrayProto, arguments));
};
// Produce an array that contains every item shared between all the
// passed-in arrays.
_.intersection = function(array) {
var rest = slice.call(arguments, 1);
return _.filter(_.uniq(array), function(item) {
return _.every(rest, function(other) {
return _.indexOf(other, item) >= 0;
});
});
};
// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
_.difference = function(array) {
var rest = concat.apply(ArrayProto, slice.call(arguments, 1));
return _.filter(array, function(value){ return !_.contains(rest, value); });
};
// Zip together multiple lists into a single array -- elements that share
// an index go together.
_.zip = function() {
var args = slice.call(arguments);
var length = _.max(_.pluck(args, 'length'));
var results = new Array(length);
for (var i = 0; i < length; i++) {
results[i] = _.pluck(args, "" + i);
}
return results;
};
// Converts lists into objects. Pass either a single array of `[key, value]`
// pairs, or two parallel arrays of the same length -- one of keys, and one of
// the corresponding values.
_.object = function(list, values) {
if (list == null) return {};
var result = {};
for (var i = 0, l = list.length; i < l; i++) {
if (values) {
result[list[i]] = values[i];
} else {
result[list[i][0]] = list[i][1];
}
}
return result;
};
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
// we need this function. Return the position of the first occurrence of an
// item in an array, or -1 if the item is not included in the array.
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
// If the array is large and already in sort order, pass `true`
// for **isSorted** to use binary search.
_.indexOf = function(array, item, isSorted) {
if (array == null) return -1;
var i = 0, l = array.length;
if (isSorted) {
if (typeof isSorted == 'number') {
i = (isSorted < 0 ? Math.max(0, l + isSorted) : isSorted);
} else {
i = _.sortedIndex(array, item);
return array[i] === item ? i : -1;
}
}
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item, isSorted);
for (; i < l; i++) if (array[i] === item) return i;
return -1;
};
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
_.lastIndexOf = function(array, item, from) {
if (array == null) return -1;
var hasIndex = from != null;
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) {
return hasIndex ? array.lastIndexOf(item, from) : array.lastIndexOf(item);
}
var i = (hasIndex ? from : array.length);
while (i--) if (array[i] === item) return i;
return -1;
};
// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](http://docs.python.org/library/functions.html#range).
_.range = function(start, stop, step) {
if (arguments.length <= 1) {
stop = start || 0;
start = 0;
}
step = arguments[2] || 1;
var len = Math.max(Math.ceil((stop - start) / step), 0);
var idx = 0;
var range = new Array(len);
while(idx < len) {
range[idx++] = start;
start += step;
}
return range;
};
// Function (ahem) Functions
// ------------------
// Create a function bound to a given object (assigning `this`, and arguments,
// optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if
// available.
_.bind = function(func, context) {
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
var args = slice.call(arguments, 2);
return function() {
return func.apply(context, args.concat(slice.call(arguments)));
};
};
// Partially apply a function by creating a version that has had some of its
// arguments pre-filled, without changing its dynamic `this` context.
_.partial = function(func) {
var args = slice.call(arguments, 1);
return function() {
return func.apply(this, args.concat(slice.call(arguments)));
};
};
// Bind all of an object's methods to that object. Useful for ensuring that
// all callbacks defined on an object belong to it.
_.bindAll = function(obj) {
var funcs = slice.call(arguments, 1);
if (funcs.length === 0) funcs = _.functions(obj);
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
return obj;
};
// Memoize an expensive function by storing its results.
_.memoize = function(func, hasher) {
var memo = {};
hasher || (hasher = _.identity);
return function() {
var key = hasher.apply(this, arguments);
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
};
};
// Delays a function for the given number of milliseconds, and then calls
// it with the arguments supplied.
_.delay = function(func, wait) {
var args = slice.call(arguments, 2);
return setTimeout(function(){ return func.apply(null, args); }, wait);
};
// Defers a function, scheduling it to run after the current call stack has
// cleared.
_.defer = function(func) {
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
};
// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time.
_.throttle = function(func, wait) {
var context, args, timeout, result;
var previous = 0;
var later = function() {
previous = new Date;
timeout = null;
result = func.apply(context, args);
};
return function() {
var now = new Date;
var remaining = wait - (now - previous);
context = this;
args = arguments;
if (remaining <= 0) {
clearTimeout(timeout);
timeout = null;
previous = now;
result = func.apply(context, args);
} else if (!timeout) {
timeout = setTimeout(later, remaining);
}
return result;
};
};
// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
_.debounce = function(func, wait, immediate) {
var timeout, result;
return function() {
var context = this, args = arguments;
var later = function() {
timeout = null;
if (!immediate) result = func.apply(context, args);
};
var callNow = immediate && !timeout;
clearTimeout(timeout);
timeout = setTimeout(later, wait);
if (callNow) result = func.apply(context, args);
return result;
};
};
// Returns a function that will be executed at most one time, no matter how
// often you call it. Useful for lazy initialization.
_.once = function(func) {
var ran = false, memo;
return function() {
if (ran) return memo;
ran = true;
memo = func.apply(this, arguments);
func = null;
return memo;
};
};
// Returns the first function passed as an argument to the second,
// allowing you to adjust arguments, run code before and after, and
// conditionally execute the original function.
_.wrap = function(func, wrapper) {
return function() {
var args = [func];
push.apply(args, arguments);
return wrapper.apply(this, args);
};
};
// Returns a function that is the composition of a list of functions, each
// consuming the return value of the function that follows.
_.compose = function() {
var funcs = arguments;
return function() {
var args = arguments;
for (var i = funcs.length - 1; i >= 0; i--) {
args = [funcs[i].apply(this, args)];
}
return args[0];
};
};
// Returns a function that will only be executed after being called N times.
_.after = function(times, func) {
if (times <= 0) return func();
return function() {
if (--times < 1) {
return func.apply(this, arguments);
}
};
};
// Object Functions
// ----------------
// Retrieve the names of an object's properties.
// Delegates to **ECMAScript 5**'s native `Object.keys`
_.keys = nativeKeys || function(obj) {
if (obj !== Object(obj)) throw new TypeError('Invalid object');
var keys = [];
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
return keys;
};
// Retrieve the values of an object's properties.
_.values = function(obj) {
var values = [];
for (var key in obj) if (_.has(obj, key)) values.push(obj[key]);
return values;
};
// Convert an object into a list of `[key, value]` pairs.
_.pairs = function(obj) {
var pairs = [];
for (var key in obj) if (_.has(obj, key)) pairs.push([key, obj[key]]);
return pairs;
};
// Invert the keys and values of an object. The values must be serializable.
_.invert = function(obj) {
var result = {};
for (var key in obj) if (_.has(obj, key)) result[obj[key]] = key;
return result;
};
// Return a sorted list of the function names available on the object.
// Aliased as `methods`
_.functions = _.methods = function(obj) {
var names = [];
for (var key in obj) {
if (_.isFunction(obj[key])) names.push(key);
}
return names.sort();
};
// Extend a given object with all the properties in passed-in object(s).
_.extend = function(obj) {
each(slice.call(arguments, 1), function(source) {
if (source) {
for (var prop in source) {
obj[prop] = source[prop];
}
}
});
return obj;
};
// Return a copy of the object only containing the whitelisted properties.
_.pick = function(obj) {
var copy = {};
var keys = concat.apply(ArrayProto, slice.call(arguments, 1));
each(keys, function(key) {
if (key in obj) copy[key] = obj[key];
});
return copy;
};
// Return a copy of the object without the blacklisted properties.
_.omit = function(obj) {
var copy = {};
var keys = concat.apply(ArrayProto, slice.call(arguments, 1));
for (var key in obj) {
if (!_.contains(keys, key)) copy[key] = obj[key];
}
return copy;
};
// Fill in a given object with default properties.
_.defaults = function(obj) {
each(slice.call(arguments, 1), function(source) {
if (source) {
for (var prop in source) {
if (obj[prop] == null) obj[prop] = source[prop];
}
}
});
return obj;
};
// Create a (shallow-cloned) duplicate of an object.
_.clone = function(obj) {
if (!_.isObject(obj)) return obj;
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
};
// Invokes interceptor with the obj, and then returns obj.
// The primary purpose of this method is to "tap into" a method chain, in
// order to perform operations on intermediate results within the chain.
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};
// Internal recursive comparison function for `isEqual`.
var eq = function(a, b, aStack, bStack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
if (a === b) return a !== 0 || 1 / a == 1 / b;
// A strict comparison is necessary because `null == undefined`.
if (a == null || b == null) return a === b;
// Unwrap any wrapped objects.
if (a instanceof _) a = a._wrapped;
if (b instanceof _) b = b._wrapped;
// Compare `[[Class]]` names.
var className = toString.call(a);
if (className != toString.call(b)) return false;
switch (className) {
// Strings, numbers, dates, and booleans are compared by value.
case '[object String]':
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
// equivalent to `new String("5")`.
return a == String(b);
case '[object Number]':
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
// other numeric values.
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
// millisecond representations. Note that invalid dates with millisecond representations
// of `NaN` are not equivalent.
return +a == +b;
// RegExps are compared by their source patterns and flags.
case '[object RegExp]':
return a.source == b.source &&
a.global == b.global &&
a.multiline == b.multiline &&
a.ignoreCase == b.ignoreCase;
}
if (typeof a != 'object' || typeof b != 'object') return false;
// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
var length = aStack.length;
while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (aStack[length] == a) return bStack[length] == b;
}
// Add the first object to the stack of traversed objects.
aStack.push(a);
bStack.push(b);
var size = 0, result = true;
// Recursively compare objects and arrays.
if (className == '[object Array]') {
// Compare array lengths to determine if a deep comparison is necessary.
size = a.length;
result = size == b.length;
if (result) {
// Deep compare the contents, ignoring non-numeric properties.
while (size--) {
if (!(result = eq(a[size], b[size], aStack, bStack))) break;
}
}
} else {
// Objects with different constructors are not equivalent, but `Object`s
// from different frames are.
var aCtor = a.constructor, bCtor = b.constructor;
if (aCtor !== bCtor && !(_.isFunction(aCtor) && (aCtor instanceof aCtor) &&
_.isFunction(bCtor) && (bCtor instanceof bCtor))) {
return false;
}
// Deep compare objects.
for (var key in a) {
if (_.has(a, key)) {
// Count the expected number of properties.
size++;
// Deep compare each member.
if (!(result = _.has(b, key) && eq(a[key], b[key], aStack, bStack))) break;
}
}
// Ensure that both objects contain the same number of properties.
if (result) {
for (key in b) {
if (_.has(b, key) && !(size--)) break;
}
result = !size;
}
}
// Remove the first object from the stack of traversed objects.
aStack.pop();
bStack.pop();
return result;
};
// Perform a deep comparison to check if two objects are equal.
_.isEqual = function(a, b) {
return eq(a, b, [], []);
};
// Is a given array, string, or object empty?
// An "empty" object has no enumerable own-properties.
_.isEmpty = function(obj) {
if (obj == null) return true;
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
for (var key in obj) if (_.has(obj, key)) return false;
return true;
};
// Is a given value a DOM element?
_.isElement = function(obj) {
return !!(obj && obj.nodeType === 1);
};
// Is a given value an array?
// Delegates to ECMA5's native Array.isArray
_.isArray = nativeIsArray || function(obj) {
return toString.call(obj) == '[object Array]';
};
// Is a given variable an object?
_.isObject = function(obj) {
return obj === Object(obj);
};
// Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp.
each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp'], function(name) {
_['is' + name] = function(obj) {
return toString.call(obj) == '[object ' + name + ']';
};
});
// Define a fallback version of the method in browsers (ahem, IE), where
// there isn't any inspectable "Arguments" type.
if (!_.isArguments(arguments)) {
_.isArguments = function(obj) {
return !!(obj && _.has(obj, 'callee'));
};
}
// Optimize `isFunction` if appropriate.
if (typeof (/./) !== 'function') {
_.isFunction = function(obj) {
return typeof obj === 'function';
};
}
// Is a given object a finite number?
_.isFinite = function(obj) {
return isFinite(obj) && !isNaN(parseFloat(obj));
};
// Is the given value `NaN`? (NaN is the only number which does not equal itself).
_.isNaN = function(obj) {
return _.isNumber(obj) && obj != +obj;
};
// Is a given value a boolean?
_.isBoolean = function(obj) {
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
};
// Is a given value equal to null?
_.isNull = function(obj) {
return obj === null;
};
// Is a given variable undefined?
_.isUndefined = function(obj) {
return obj === void 0;
};
// Shortcut function for checking if an object has a given property directly
// on itself (in other words, not on a prototype).
_.has = function(obj, key) {
return hasOwnProperty.call(obj, key);
};
// Utility Functions
// -----------------
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
// previous owner. Returns a reference to the Underscore object.
_.noConflict = function() {
root._ = previousUnderscore;
return this;
};
// Keep the identity function around for default iterators.
_.identity = function(value) {
return value;
};
// Run a function **n** times.
_.times = function(n, iterator, context) {
var accum = Array(n);
for (var i = 0; i < n; i++) accum[i] = iterator.call(context, i);
return accum;
};
// Return a random integer between min and max (inclusive).
_.random = function(min, max) {
if (max == null) {
max = min;
min = 0;
}
return min + Math.floor(Math.random() * (max - min + 1));
};
// List of HTML entities for escaping.
var entityMap = {
escape: {
'&': '&amp;',
'<': '&lt;',
'>': '&gt;',
'"': '&quot;',
"'": '&#x27;',
'/': '&#x2F;'
}
};
entityMap.unescape = _.invert(entityMap.escape);
// Regexes containing the keys and values listed immediately above.
var entityRegexes = {
escape: new RegExp('[' + _.keys(entityMap.escape).join('') + ']', 'g'),
unescape: new RegExp('(' + _.keys(entityMap.unescape).join('|') + ')', 'g')
};
// Functions for escaping and unescaping strings to/from HTML interpolation.
_.each(['escape', 'unescape'], function(method) {
_[method] = function(string) {
if (string == null) return '';
return ('' + string).replace(entityRegexes[method], function(match) {
return entityMap[method][match];
});
};
});
// If the value of the named property is a function then invoke it;
// otherwise, return it.
_.result = function(object, property) {
if (object == null) return null;
var value = object[property];
return _.isFunction(value) ? value.call(object) : value;
};
// Add your own custom functions to the Underscore object.
_.mixin = function(obj) {
each(_.functions(obj), function(name){
var func = _[name] = obj[name];
_.prototype[name] = function() {
var args = [this._wrapped];
push.apply(args, arguments);
return result.call(this, func.apply(_, args));
};
});
};
// Generate a unique integer id (unique within the entire client session).
// Useful for temporary DOM ids.
var idCounter = 0;
_.uniqueId = function(prefix) {
var id = ++idCounter + '';
return prefix ? prefix + id : id;
};
// By default, Underscore uses ERB-style template delimiters, change the
// following template settings to use alternative delimiters.
_.templateSettings = {
evaluate : /<%([\s\S]+?)%>/g,
interpolate : /<%=([\s\S]+?)%>/g,
escape : /<%-([\s\S]+?)%>/g
};
// When customizing `templateSettings`, if you don't want to define an
// interpolation, evaluation or escaping regex, we need one that is
// guaranteed not to match.
var noMatch = /(.)^/;
// Certain characters need to be escaped so that they can be put into a
// string literal.
var escapes = {
"'": "'",
'\\': '\\',
'\r': 'r',
'\n': 'n',
'\t': 't',
'\u2028': 'u2028',
'\u2029': 'u2029'
};
var escaper = /\\|'|\r|\n|\t|\u2028|\u2029/g;
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
_.template = function(text, data, settings) {
var render;
settings = _.defaults({}, settings, _.templateSettings);
// Combine delimiters into one regular expression via alternation.
var matcher = new RegExp([
(settings.escape || noMatch).source,
(settings.interpolate || noMatch).source,
(settings.evaluate || noMatch).source
].join('|') + '|$', 'g');
// Compile the template source, escaping string literals appropriately.
var index = 0;
var source = "__p+='";
text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
source += text.slice(index, offset)
.replace(escaper, function(match) { return '\\' + escapes[match]; });
if (escape) {
source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
}
if (interpolate) {
source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
}
if (evaluate) {
source += "';\n" + evaluate + "\n__p+='";
}
index = offset + match.length;
return match;
});
source += "';\n";
// If a variable is not specified, place data values in local scope.
if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n';
source = "var __t,__p='',__j=Array.prototype.join," +
"print=function(){__p+=__j.call(arguments,'');};\n" +
source + "return __p;\n";
try {
render = new Function(settings.variable || 'obj', '_', source);
} catch (e) {
e.source = source;
throw e;
}
if (data) return render(data, _);
var template = function(data) {
return render.call(this, data, _);
};
// Provide the compiled function source as a convenience for precompilation.
template.source = 'function(' + (settings.variable || 'obj') + '){\n' + source + '}';
return template;
};
// Add a "chain" function, which will delegate to the wrapper.
_.chain = function(obj) {
return _(obj).chain();
};
// OOP
// ---------------
// If Underscore is called as a function, it returns a wrapped object that
// can be used OO-style. This wrapper holds altered versions of all the
// underscore functions. Wrapped objects may be chained.
// Helper function to continue chaining intermediate results.
var result = function(obj) {
return this._chain ? _(obj).chain() : obj;
};
// Add all of the Underscore functions to the wrapper object.
_.mixin(_);
// Add all mutator Array functions to the wrapper.
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
var obj = this._wrapped;
method.apply(obj, arguments);
if ((name == 'shift' || name == 'splice') && obj.length === 0) delete obj[0];
return result.call(this, obj);
};
});
// Add all accessor Array functions to the wrapper.
each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
return result.call(this, method.apply(this._wrapped, arguments));
};
});
_.extend(_.prototype, {
// Start chaining a wrapped Underscore object.
chain: function() {
this._chain = true;
return this;
},
// Extracts the result from a wrapped and chained object.
value: function() {
return this._wrapped;
}
});
}).call(this);
_static/up.png 0 → 100644
View file @ c6d958c9
_static/up.png

363 Bytes

_static/websupport.js 0 → 100644
View file @ c6d958c9
/*
* websupport.js
* ~~~~~~~~~~~~~
*
* sphinx.websupport utilties for all documentation.
*
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
(function($) {
$.fn.autogrow = function() {
return this.each(function() {
var textarea = this;
$.fn.autogrow.resize(textarea);
$(textarea)
.focus(function() {
textarea.interval = setInterval(function() {
$.fn.autogrow.resize(textarea);
}, 500);
})
.blur(function() {
clearInterval(textarea.interval);
});
});
};
$.fn.autogrow.resize = function(textarea) {
var lineHeight = parseInt($(textarea).css('line-height'), 10);
var lines = textarea.value.split('\n');
var columns = textarea.cols;
var lineCount = 0;
$.each(lines, function() {
lineCount += Math.ceil(this.length / columns) || 1;
});
var height = lineHeight * (lineCount + 1);
$(textarea).css('height', height);
};
})(jQuery);
(function($) {
var comp, by;
function init() {
initEvents();
initComparator();
}
function initEvents() {
$('a.comment-close').live("click", function(event) {
event.preventDefault();
hide($(this).attr('id').substring(2));
});
$('a.vote').live("click", function(event) {
event.preventDefault();
handleVote($(this));
});
$('a.reply').live("click", function(event) {
event.preventDefault();
openReply($(this).attr('id').substring(2));
});
$('a.close-reply').live("click", function(event) {
event.preventDefault();
closeReply($(this).attr('id').substring(2));
});
$('a.sort-option').live("click", function(event) {
event.preventDefault();
handleReSort($(this));
});
$('a.show-proposal').live("click", function(event) {
event.preventDefault();
showProposal($(this).attr('id').substring(2));
});
$('a.hide-proposal').live("click", function(event) {
event.preventDefault();
hideProposal($(this).attr('id').substring(2));
});
$('a.show-propose-change').live("click", function(event) {
event.preventDefault();
showProposeChange($(this).attr('id').substring(2));
});
$('a.hide-propose-change').live("click", function(event) {
event.preventDefault();
hideProposeChange($(this).attr('id').substring(2));
});
$('a.accept-comment').live("click", function(event) {
event.preventDefault();
acceptComment($(this).attr('id').substring(2));
});
$('a.delete-comment').live("click", function(event) {
event.preventDefault();
deleteComment($(this).attr('id').substring(2));
});
$('a.comment-markup').live("click", function(event) {
event.preventDefault();
toggleCommentMarkupBox($(this).attr('id').substring(2));
});
}
/**
* Set comp, which is a comparator function used for sorting and
* inserting comments into the list.
*/
function setComparator() {
// If the first three letters are "asc", sort in ascending order
// and remove the prefix.
if (by.substring(0,3) == 'asc') {
var i = by.substring(3);
comp = function(a, b) { return a[i] - b[i]; };
} else {
// Otherwise sort in descending order.
comp = function(a, b) { return b[by] - a[by]; };
}
// Reset link styles and format the selected sort option.
$('a.sel').attr('href', '#').removeClass('sel');
$('a.by' + by).removeAttr('href').addClass('sel');
}
/**
* Create a comp function. If the user has preferences stored in
* the sortBy cookie, use those, otherwise use the default.
*/
function initComparator() {
by = 'rating'; // Default to sort by rating.
// If the sortBy cookie is set, use that instead.
if (document.cookie.length > 0) {
var start = document.cookie.indexOf('sortBy=');
if (start != -1) {
start = start + 7;
var end = document.cookie.indexOf(";", start);
if (end == -1) {
end = document.cookie.length;
by = unescape(document.cookie.substring(start, end));
}
}
}
setComparator();
}
/**
* Show a comment div.
*/
function show(id) {
$('#ao' + id).hide();
$('#ah' + id).show();
var context = $.extend({id: id}, opts);
var popup = $(renderTemplate(popupTemplate, context)).hide();
popup.find('textarea[name="proposal"]').hide();
popup.find('a.by' + by).addClass('sel');
var form = popup.find('#cf' + id);
form.submit(function(event) {
event.preventDefault();
addComment(form);
});
$('#s' + id).after(popup);
popup.slideDown('fast', function() {
getComments(id);
});
}
/**
* Hide a comment div.
*/
function hide(id) {
$('#ah' + id).hide();
$('#ao' + id).show();
var div = $('#sc' + id);
div.slideUp('fast', function() {
div.remove();
});
}
/**
* Perform an ajax request to get comments for a node
* and insert the comments into the comments tree.
*/
function getComments(id) {
$.ajax({
type: 'GET',
url: opts.getCommentsURL,
data: {node: id},
success: function(data, textStatus, request) {
var ul = $('#cl' + id);
var speed = 100;
$('#cf' + id)
.find('textarea[name="proposal"]')
.data('source', data.source);
if (data.comments.length === 0) {
ul.html('<li>No comments yet.</li>');
ul.data('empty', true);
} else {
// If there are comments, sort them and put them in the list.
var comments = sortComments(data.comments);
speed = data.comments.length * 100;
appendComments(comments, ul);
ul.data('empty', false);
}
$('#cn' + id).slideUp(speed + 200);
ul.slideDown(speed);
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem retrieving the comments.');
},
dataType: 'json'
});
}
/**
* Add a comment via ajax and insert the comment into the comment tree.
*/
function addComment(form) {
var node_id = form.find('input[name="node"]').val();
var parent_id = form.find('input[name="parent"]').val();
var text = form.find('textarea[name="comment"]').val();
var proposal = form.find('textarea[name="proposal"]').val();
if (text == '') {
showError('Please enter a comment.');
return;
}
// Disable the form that is being submitted.
form.find('textarea,input').attr('disabled', 'disabled');
// Send the comment to the server.
$.ajax({
type: "POST",
url: opts.addCommentURL,
dataType: 'json',
data: {
node: node_id,
parent: parent_id,
text: text,
proposal: proposal
},
success: function(data, textStatus, error) {
// Reset the form.
if (node_id) {
hideProposeChange(node_id);
}
form.find('textarea')
.val('')
.add(form.find('input'))
.removeAttr('disabled');
var ul = $('#cl' + (node_id || parent_id));
if (ul.data('empty')) {
$(ul).empty();
ul.data('empty', false);
}
insertComment(data.comment);
var ao = $('#ao' + node_id);
ao.find('img').attr({'src': opts.commentBrightImage});
if (node_id) {
// if this was a "root" comment, remove the commenting box
// (the user can get it back by reopening the comment popup)
$('#ca' + node_id).slideUp();
}
},
error: function(request, textStatus, error) {
form.find('textarea,input').removeAttr('disabled');
showError('Oops, there was a problem adding the comment.');
}
});
}
/**
* Recursively append comments to the main comment list and children
* lists, creating the comment tree.
*/
function appendComments(comments, ul) {
$.each(comments, function() {
var div = createCommentDiv(this);
ul.append($(document.createElement('li')).html(div));
appendComments(this.children, div.find('ul.comment-children'));
// To avoid stagnating data, don't store the comments children in data.
this.children = null;
div.data('comment', this);
});
}
/**
* After adding a new comment, it must be inserted in the correct
* location in the comment tree.
*/
function insertComment(comment) {
var div = createCommentDiv(comment);
// To avoid stagnating data, don't store the comments children in data.
comment.children = null;
div.data('comment', comment);
var ul = $('#cl' + (comment.node || comment.parent));
var siblings = getChildren(ul);
var li = $(document.createElement('li'));
li.hide();
// Determine where in the parents children list to insert this comment.
for(i=0; i < siblings.length; i++) {
if (comp(comment, siblings[i]) <= 0) {
$('#cd' + siblings[i].id)
.parent()
.before(li.html(div));
li.slideDown('fast');
return;
}
}
// If we get here, this comment rates lower than all the others,
// or it is the only comment in the list.
ul.append(li.html(div));
li.slideDown('fast');
}
function acceptComment(id) {
$.ajax({
type: 'POST',
url: opts.acceptCommentURL,
data: {id: id},
success: function(data, textStatus, request) {
$('#cm' + id).fadeOut('fast');
$('#cd' + id).removeClass('moderate');
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem accepting the comment.');
}
});
}
function deleteComment(id) {
$.ajax({
type: 'POST',
url: opts.deleteCommentURL,
data: {id: id},
success: function(data, textStatus, request) {
var div = $('#cd' + id);
if (data == 'delete') {
// Moderator mode: remove the comment and all children immediately
div.slideUp('fast', function() {
div.remove();
});
return;
}
// User mode: only mark the comment as deleted
div
.find('span.user-id:first')
.text('[deleted]').end()
.find('div.comment-text:first')
.text('[deleted]').end()
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
.remove();
var comment = div.data('comment');
comment.username = '[deleted]';
comment.text = '[deleted]';
div.data('comment', comment);
},
error: function(request, textStatus, error) {
showError('Oops, there was a problem deleting the comment.');
}
});
}
function showProposal(id) {
$('#sp' + id).hide();
$('#hp' + id).show();
$('#pr' + id).slideDown('fast');
}
function hideProposal(id) {
$('#hp' + id).hide();
$('#sp' + id).show();
$('#pr' + id).slideUp('fast');
}
function showProposeChange(id) {
$('#pc' + id).hide();
$('#hc' + id).show();
var textarea = $('#pt' + id);
textarea.val(textarea.data('source'));
$.fn.autogrow.resize(textarea[0]);
textarea.slideDown('fast');
}
function hideProposeChange(id) {
$('#hc' + id).hide();
$('#pc' + id).show();
var textarea = $('#pt' + id);
textarea.val('').removeAttr('disabled');
textarea.slideUp('fast');
}
function toggleCommentMarkupBox(id) {
$('#mb' + id).toggle();
}
/** Handle when the user clicks on a sort by link. */
function handleReSort(link) {
var classes = link.attr('class').split(/\s+/);
for (var i=0; i<classes.length; i++) {
if (classes[i] != 'sort-option') {
by = classes[i].substring(2);
}
}
setComparator();
// Save/update the sortBy cookie.
var expiration = new Date();
expiration.setDate(expiration.getDate() + 365);
document.cookie= 'sortBy=' + escape(by) +
';expires=' + expiration.toUTCString();
$('ul.comment-ul').each(function(index, ul) {
var comments = getChildren($(ul), true);
comments = sortComments(comments);
appendComments(comments, $(ul).empty());
});
}
/**
* Function to process a vote when a user clicks an arrow.
*/
function handleVote(link) {
if (!opts.voting) {
showError("You'll need to login to vote.");
return;
}
var id = link.attr('id');
if (!id) {
// Didn't click on one of the voting arrows.
return;
}
// If it is an unvote, the new vote value is 0,
// Otherwise it's 1 for an upvote, or -1 for a downvote.
var value = 0;
if (id.charAt(1) != 'u') {
value = id.charAt(0) == 'u' ? 1 : -1;
}
// The data to be sent to the server.
var d = {
comment_id: id.substring(2),
value: value
};
// Swap the vote and unvote links.
link.hide();
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
.show();
// The div the comment is displayed in.
var div = $('div#cd' + d.comment_id);
var data = div.data('comment');
// If this is not an unvote, and the other vote arrow has
// already been pressed, unpress it.
if ((d.value !== 0) && (data.vote === d.value * -1)) {
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
}
// Update the comments rating in the local data.
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
data.vote = d.value;
div.data('comment', data);
// Change the rating text.
div.find('.rating:first')
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
// Send the vote information to the server.
$.ajax({
type: "POST",
url: opts.processVoteURL,
data: d,
error: function(request, textStatus, error) {
showError('Oops, there was a problem casting that vote.');
}
});
}
/**
* Open a reply form used to reply to an existing comment.
*/
function openReply(id) {
// Swap out the reply link for the hide link
$('#rl' + id).hide();
$('#cr' + id).show();
// Add the reply li to the children ul.
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
$('#cl' + id)
.prepend(div)
// Setup the submit handler for the reply form.
.find('#rf' + id)
.submit(function(event) {
event.preventDefault();
addComment($('#rf' + id));
closeReply(id);
})
.find('input[type=button]')
.click(function() {
closeReply(id);
});
div.slideDown('fast', function() {
$('#rf' + id).find('textarea').focus();
});
}
/**
* Close the reply form opened with openReply.
*/
function closeReply(id) {
// Remove the reply div from the DOM.
$('#rd' + id).slideUp('fast', function() {
$(this).remove();
});
// Swap out the hide link for the reply link
$('#cr' + id).hide();
$('#rl' + id).show();
}
/**
* Recursively sort a tree of comments using the comp comparator.
*/
function sortComments(comments) {
comments.sort(comp);
$.each(comments, function() {
this.children = sortComments(this.children);
});
return comments;
}
/**
* Get the children comments from a ul. If recursive is true,
* recursively include childrens' children.
*/
function getChildren(ul, recursive) {
var children = [];
ul.children().children("[id^='cd']")
.each(function() {
var comment = $(this).data('comment');
if (recursive)
comment.children = getChildren($(this).find('#cl' + comment.id), true);
children.push(comment);
});
return children;
}
/** Create a div to display a comment in. */
function createCommentDiv(comment) {
if (!comment.displayed && !opts.moderator) {
return $('<div class="moderate">Thank you! Your comment will show up '
+ 'once it is has been approved by a moderator.</div>');
}
// Prettify the comment rating.
comment.pretty_rating = comment.rating + ' point' +
(comment.rating == 1 ? '' : 's');
// Make a class (for displaying not yet moderated comments differently)
comment.css_class = comment.displayed ? '' : ' moderate';
// Create a div for this comment.
var context = $.extend({}, opts, comment);
var div = $(renderTemplate(commentTemplate, context));
// If the user has voted on this comment, highlight the correct arrow.
if (comment.vote) {
var direction = (comment.vote == 1) ? 'u' : 'd';
div.find('#' + direction + 'v' + comment.id).hide();
div.find('#' + direction + 'u' + comment.id).show();
}
if (opts.moderator || comment.text != '[deleted]') {
div.find('a.reply').show();
if (comment.proposal_diff)
div.find('#sp' + comment.id).show();
if (opts.moderator && !comment.displayed)
div.find('#cm' + comment.id).show();
if (opts.moderator || (opts.username == comment.username))
div.find('#dc' + comment.id).show();
}
return div;
}
/**
* A simple template renderer. Placeholders such as <%id%> are replaced
* by context['id'] with items being escaped. Placeholders such as <#id#>
* are not escaped.
*/
function renderTemplate(template, context) {
var esc = $(document.createElement('div'));
function handle(ph, escape) {
var cur = context;
$.each(ph.split('.'), function() {
cur = cur[this];
});
return escape ? esc.text(cur || "").html() : cur;
}
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
return handle(arguments[2], arguments[1] == '%' ? true : false);
});
}
/** Flash an error message briefly. */
function showError(message) {
$(document.createElement('div')).attr({'class': 'popup-error'})
.append($(document.createElement('div'))
.attr({'class': 'error-message'}).text(message))
.appendTo('body')
.fadeIn("slow")
.delay(2000)
.fadeOut("slow");
}
/** Add a link the user uses to open the comments popup. */
$.fn.comment = function() {
return this.each(function() {
var id = $(this).attr('id').substring(1);
var count = COMMENT_METADATA[id];
var title = count + ' comment' + (count == 1 ? '' : 's');
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
var addcls = count == 0 ? ' nocomment' : '';
$(this)
.append(
$(document.createElement('a')).attr({
href: '#',
'class': 'sphinx-comment-open' + addcls,
id: 'ao' + id
})
.append($(document.createElement('img')).attr({
src: image,
alt: 'comment',
title: title
}))
.click(function(event) {
event.preventDefault();
show($(this).attr('id').substring(2));
})
)
.append(
$(document.createElement('a')).attr({
href: '#',
'class': 'sphinx-comment-close hidden',
id: 'ah' + id
})
.append($(document.createElement('img')).attr({
src: opts.closeCommentImage,
alt: 'close',
title: 'close'
}))
.click(function(event) {
event.preventDefault();
hide($(this).attr('id').substring(2));
})
);
});
};
var opts = {
processVoteURL: '/_process_vote',
addCommentURL: '/_add_comment',
getCommentsURL: '/_get_comments',
acceptCommentURL: '/_accept_comment',
deleteCommentURL: '/_delete_comment',
commentImage: '/static/_static/comment.png',
closeCommentImage: '/static/_static/comment-close.png',
loadingImage: '/static/_static/ajax-loader.gif',
commentBrightImage: '/static/_static/comment-bright.png',
upArrow: '/static/_static/up.png',
downArrow: '/static/_static/down.png',
upArrowPressed: '/static/_static/up-pressed.png',
downArrowPressed: '/static/_static/down-pressed.png',
voting: false,
moderator: false
};
if (typeof COMMENT_OPTIONS != "undefined") {
opts = jQuery.extend(opts, COMMENT_OPTIONS);
}
var popupTemplate = '\
<div class="sphinx-comments" id="sc<%id%>">\
<p class="sort-options">\
Sort by:\
<a href="#" class="sort-option byrating">best rated</a>\
<a href="#" class="sort-option byascage">newest</a>\
<a href="#" class="sort-option byage">oldest</a>\
</p>\
<div class="comment-header">Comments</div>\
<div class="comment-loading" id="cn<%id%>">\
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
<ul id="cl<%id%>" class="comment-ul"></ul>\
<div id="ca<%id%>">\
<p class="add-a-comment">Add a comment\
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
<div class="comment-markup-box" id="mb<%id%>">\
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
<tt>``code``</tt>, \
code blocks: <tt>::</tt> and an indented block after blank line</div>\
<form method="post" id="cf<%id%>" class="comment-form" action="">\
<textarea name="comment" cols="80"></textarea>\
<p class="propose-button">\
<a href="#" id="pc<%id%>" class="show-propose-change">\
Propose a change &#9657;\
</a>\
<a href="#" id="hc<%id%>" class="hide-propose-change">\
Propose a change &#9663;\
</a>\
</p>\
<textarea name="proposal" id="pt<%id%>" cols="80"\
spellcheck="false"></textarea>\
<input type="submit" value="Add comment" />\
<input type="hidden" name="node" value="<%id%>" />\
<input type="hidden" name="parent" value="" />\
</form>\
</div>\
</div>';
var commentTemplate = '\
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
<div class="vote">\
<div class="arrow">\
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
<img src="<%upArrow%>" />\
</a>\
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
<img src="<%upArrowPressed%>" />\
</a>\
</div>\
<div class="arrow">\
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
<img src="<%downArrow%>" id="da<%id%>" />\
</a>\
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
<img src="<%downArrowPressed%>" />\
</a>\
</div>\
</div>\
<div class="comment-content">\
<p class="tagline comment">\
<span class="user-id"><%username%></span>\
<span class="rating"><%pretty_rating%></span>\
<span class="delta"><%time.delta%></span>\
</p>\
<div class="comment-text comment"><#text#></div>\
<p class="comment-opts comment">\
<a href="#" class="reply hidden" id="rl<%id%>">reply &#9657;</a>\
<a href="#" class="close-reply" id="cr<%id%>">reply &#9663;</a>\
<a href="#" id="sp<%id%>" class="show-proposal">proposal &#9657;</a>\
<a href="#" id="hp<%id%>" class="hide-proposal">proposal &#9663;</a>\
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
<span id="cm<%id%>" class="moderation hidden">\
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
</span>\
</p>\
<pre class="proposal" id="pr<%id%>">\
<#proposal_diff#>\
</pre>\
<ul class="comment-children" id="cl<%id%>"></ul>\
</div>\
<div class="clearleft"></div>\
</div>\
</div>';
var replyTemplate = '\
<li>\
<div class="reply-div" id="rd<%id%>">\
<form id="rf<%id%>">\
<textarea name="comment" cols="80"></textarea>\
<input type="submit" value="Add reply" />\
<input type="button" value="Cancel" />\
<input type="hidden" name="parent" value="<%id%>" />\
<input type="hidden" name="node" value="" />\
</form>\
</div>\
</li>';
$(document).ready(function() {
init();
});
})(jQuery);
$(document).ready(function() {
// add comment anchors for all paragraphs that are commentable
$('.sphinx-has-comment').comment();
// highlight search words in search results
$("div.context").each(function() {
var params = $.getQueryParameters();
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
var result = $(this);
$.each(terms, function() {
result.highlightText(this.toLowerCase(), 'highlighted');
});
});
// directly open comment window if requested
var anchor = document.location.hash;
if (anchor.substring(0, 9) == '#comment-') {
$('#ao' + anchor.substring(9)).click();
document.location.hash = '#s' + anchor.substring(9);
}
});
apiref.html 0 → 100644
View file @ c6d958c9
This source diff could not be displayed because it is too large. You can view the blob instead.
genindex.html 0 → 100644
View file @ c6d958c9
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; nghttp2 0.1.0-DEV documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/default2.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0-DEV',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#N"><strong>N</strong></a>
</div>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="apiref.html#nghttp2_before_frame_send_callback">nghttp2_before_frame_send_callback (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_CANCEL">NGHTTP2_CANCEL (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_CLIENT_CONNECTION_HEADER">NGHTTP2_CLIENT_CONNECTION_HEADER (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_CLIENT_CONNECTION_HEADER_LEN">NGHTTP2_CLIENT_CONNECTION_HEADER_LEN (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_COMPRESSION_ERROR">NGHTTP2_COMPRESSION_ERROR (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_DATA">NGHTTP2_DATA (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_provider">nghttp2_data_provider (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_provider.read_callback">nghttp2_data_provider.read_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_provider.source">nghttp2_data_provider.source (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_source">nghttp2_data_source (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_source.fd">nghttp2_data_source.fd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_source.ptr">nghttp2_data_source.ptr (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_data_source_read_callback">nghttp2_data_source_read_callback (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_CALLBACK_FAILURE">NGHTTP2_ERR_CALLBACK_FAILURE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_DEFERRED">NGHTTP2_ERR_DEFERRED (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_DEFERRED_DATA_EXIST">NGHTTP2_ERR_DEFERRED_DATA_EXIST (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_EOF">NGHTTP2_ERR_EOF (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_FATAL">NGHTTP2_ERR_FATAL (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_FRAME_TOO_LARGE">NGHTTP2_ERR_FRAME_TOO_LARGE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_GOAWAY_ALREADY_SENT">NGHTTP2_ERR_GOAWAY_ALREADY_SENT (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_GZIP">NGHTTP2_ERR_GZIP (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_HEADER_COMP">NGHTTP2_ERR_HEADER_COMP (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_ARGUMENT">NGHTTP2_ERR_INVALID_ARGUMENT (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_FRAME">NGHTTP2_ERR_INVALID_FRAME (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_HEADER_BLOCK">NGHTTP2_ERR_INVALID_HEADER_BLOCK (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_STATE">NGHTTP2_ERR_INVALID_STATE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_STREAM_ID">NGHTTP2_ERR_INVALID_STREAM_ID (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_INVALID_STREAM_STATE">NGHTTP2_ERR_INVALID_STREAM_STATE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_NOMEM">NGHTTP2_ERR_NOMEM (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_PROTO">NGHTTP2_ERR_PROTO (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_START_STREAM_NOT_ALLOWED">NGHTTP2_ERR_START_STREAM_NOT_ALLOWED (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_STREAM_CLOSED">NGHTTP2_ERR_STREAM_CLOSED (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_STREAM_CLOSING">NGHTTP2_ERR_STREAM_CLOSING (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_STREAM_ID_NOT_AVAILABLE">NGHTTP2_ERR_STREAM_ID_NOT_AVAILABLE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_STREAM_SHUT_WR">NGHTTP2_ERR_STREAM_SHUT_WR (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE">NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_UNSUPPORTED_VERSION">NGHTTP2_ERR_UNSUPPORTED_VERSION (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_ERR_WOULDBLOCK">NGHTTP2_ERR_WOULDBLOCK (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_error">nghttp2_error (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_error_code">nghttp2_error_code (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_flag">nghttp2_flag (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_FLOW_CONTROL">NGHTTP2_FLAG_END_FLOW_CONTROL (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_HEADERS">NGHTTP2_FLAG_END_HEADERS (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_PUSH_PROMISE">NGHTTP2_FLAG_END_PUSH_PROMISE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_END_STREAM">NGHTTP2_FLAG_END_STREAM (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_NONE">NGHTTP2_FLAG_NONE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_PONG">NGHTTP2_FLAG_PONG (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLAG_PRIORITY">NGHTTP2_FLAG_PRIORITY (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FLOW_CONTROL_ERROR">NGHTTP2_FLOW_CONTROL_ERROR (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame">nghttp2_frame (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.goaway">nghttp2_frame.goaway (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.hd">nghttp2_frame.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.headers">nghttp2_frame.headers (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.ping">nghttp2_frame.ping (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.priority">nghttp2_frame.priority (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.push_promise">nghttp2_frame.push_promise (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.rst_stream">nghttp2_frame.rst_stream (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.settings">nghttp2_frame.settings (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame.window_update">nghttp2_frame.window_update (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_hd">nghttp2_frame_hd (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_hd.flags">nghttp2_frame_hd.flags (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_hd.length">nghttp2_frame_hd.length (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_hd.stream_id">nghttp2_frame_hd.stream_id (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_hd.type">nghttp2_frame_hd.type (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_FRAME_TOO_LARGE">NGHTTP2_FRAME_TOO_LARGE (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_frame_type">nghttp2_frame_type (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_GOAWAY">NGHTTP2_GOAWAY (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway">nghttp2_goaway (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway.error_code">nghttp2_goaway.error_code (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway.hd">nghttp2_goaway.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway.last_stream_id">nghttp2_goaway.last_stream_id (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway.opaque_data">nghttp2_goaway.opaque_data (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_goaway.opaque_data_len">nghttp2_goaway.opaque_data_len (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_gzip">nghttp2_gzip (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_gzip_inflate">nghttp2_gzip_inflate (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_gzip_inflate_del">nghttp2_gzip_inflate_del (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_gzip_inflate_new">nghttp2_gzip_inflate_new (C function)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_HCAT_HEADERS">NGHTTP2_HCAT_HEADERS (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_HCAT_PUSH_RESPONSE">NGHTTP2_HCAT_PUSH_RESPONSE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_HCAT_REQUEST">NGHTTP2_HCAT_REQUEST (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_HCAT_RESPONSE">NGHTTP2_HCAT_RESPONSE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_HEADERS">NGHTTP2_HEADERS (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers">nghttp2_headers (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers.hd">nghttp2_headers.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers.nva">nghttp2_headers.nva (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers.nvlen">nghttp2_headers.nvlen (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers.pri">nghttp2_headers.pri (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_headers_category">nghttp2_headers_category (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE">NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS">NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_INITIAL_WINDOW_SIZE">NGHTTP2_INITIAL_WINDOW_SIZE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_INTERNAL_ERROR">NGHTTP2_INTERNAL_ERROR (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_mem_chunk">nghttp2_mem_chunk (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_mem_chunk.data">nghttp2_mem_chunk.data (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_mem_chunk.length">nghttp2_mem_chunk.length (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_NO_ERROR">NGHTTP2_NO_ERROR (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_nv">nghttp2_nv (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_nv.name">nghttp2_nv.name (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_nv.namelen">nghttp2_nv.namelen (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_nv.value">nghttp2_nv.value (C member)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="apiref.html#nghttp2_nv.valuelen">nghttp2_nv.valuelen (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_data_chunk_recv_callback">nghttp2_on_data_chunk_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_data_recv_callback">nghttp2_on_data_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_data_send_callback">nghttp2_on_data_send_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_frame_not_send_callback">nghttp2_on_frame_not_send_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_frame_recv_callback">nghttp2_on_frame_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_frame_recv_parse_error_callback">nghttp2_on_frame_recv_parse_error_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_frame_send_callback">nghttp2_on_frame_send_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_invalid_frame_recv_callback">nghttp2_on_invalid_frame_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_request_recv_callback">nghttp2_on_request_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_stream_close_callback">nghttp2_on_stream_close_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_on_unknown_frame_recv_callback">nghttp2_on_unknown_frame_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_opt">nghttp2_opt (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE">NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PING">NGHTTP2_PING (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_ping">nghttp2_ping (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_ping.hd">nghttp2_ping.hd (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PRI_DEFAULT">NGHTTP2_PRI_DEFAULT (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PRI_LOWEST">NGHTTP2_PRI_LOWEST (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PRIORITY">NGHTTP2_PRIORITY (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_priority">nghttp2_priority (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_priority.hd">nghttp2_priority.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_priority.pri">nghttp2_priority.pri (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PROTO_VERSION_ID">NGHTTP2_PROTO_VERSION_ID (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PROTO_VERSION_ID_LEN">NGHTTP2_PROTO_VERSION_ID_LEN (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PROTOCOL_ERROR">NGHTTP2_PROTOCOL_ERROR (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_PUSH_PROMISE">NGHTTP2_PUSH_PROMISE (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_push_promise">nghttp2_push_promise (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_push_promise.hd">nghttp2_push_promise.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_push_promise.nva">nghttp2_push_promise.nva (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_push_promise.nvlen">nghttp2_push_promise.nvlen (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_push_promise.promised_stream_id">nghttp2_push_promise.promised_stream_id (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_recv_callback">nghttp2_recv_callback (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_REFUSED_STREAM">NGHTTP2_REFUSED_STREAM (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_RST_STREAM">NGHTTP2_RST_STREAM (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_rst_stream">nghttp2_rst_stream (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_rst_stream.error_code">nghttp2_rst_stream.error_code (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_rst_stream.hd">nghttp2_rst_stream.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_select_next_protocol">nghttp2_select_next_protocol (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_send_callback">nghttp2_send_callback (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session">nghttp2_session (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks">nghttp2_session_callbacks (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.before_frame_send_callback">nghttp2_session_callbacks.before_frame_send_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.nghttp2_on_frame_recv_parse_error_callback">nghttp2_session_callbacks.nghttp2_on_frame_recv_parse_error_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_data_chunk_recv_callback">nghttp2_session_callbacks.on_data_chunk_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_data_recv_callback">nghttp2_session_callbacks.on_data_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_data_send_callback">nghttp2_session_callbacks.on_data_send_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_frame_not_send_callback">nghttp2_session_callbacks.on_frame_not_send_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_frame_recv_callback">nghttp2_session_callbacks.on_frame_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_frame_send_callback">nghttp2_session_callbacks.on_frame_send_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_invalid_frame_recv_callback">nghttp2_session_callbacks.on_invalid_frame_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_request_recv_callback">nghttp2_session_callbacks.on_request_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_stream_close_callback">nghttp2_session_callbacks.on_stream_close_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.on_unknown_frame_recv_callback">nghttp2_session_callbacks.on_unknown_frame_recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.recv_callback">nghttp2_session_callbacks.recv_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_callbacks.send_callback">nghttp2_session_callbacks.send_callback (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_client_new">nghttp2_session_client_new (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_del">nghttp2_session_del (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_fail_session">nghttp2_session_fail_session (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_get_outbound_queue_size">nghttp2_session_get_outbound_queue_size (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_get_stream_user_data">nghttp2_session_get_stream_user_data (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_mem_recv">nghttp2_session_mem_recv (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_recv">nghttp2_session_recv (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_resume_data">nghttp2_session_resume_data (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_send">nghttp2_session_send (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_server_new">nghttp2_session_server_new (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_set_option">nghttp2_session_set_option (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_want_read">nghttp2_session_want_read (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_session_want_write">nghttp2_session_want_write (C function)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_SETTINGS">NGHTTP2_SETTINGS (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings">nghttp2_settings (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings.hd">nghttp2_settings.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings.iv">nghttp2_settings.iv (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings.niv">nghttp2_settings.niv (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings_entry">nghttp2_settings_entry (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings_entry.settings_id">nghttp2_settings_entry.settings_id (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings_entry.value">nghttp2_settings_entry.value (C member)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_SETTINGS_FLOW_CONTROL_OPTIONS">NGHTTP2_SETTINGS_FLOW_CONTROL_OPTIONS (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_settings_id">nghttp2_settings_id (C type)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE">NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_SETTINGS_MAX">NGHTTP2_SETTINGS_MAX (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS">NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_STREAM_CLOSED">NGHTTP2_STREAM_CLOSED (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_strerror">nghttp2_strerror (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_data">nghttp2_submit_data (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_goaway">nghttp2_submit_goaway (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_headers">nghttp2_submit_headers (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_ping">nghttp2_submit_ping (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_priority">nghttp2_submit_priority (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_push_promise">nghttp2_submit_push_promise (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_request">nghttp2_submit_request (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_response">nghttp2_submit_response (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_rst_stream">nghttp2_submit_rst_stream (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_settings">nghttp2_submit_settings (C function)</a>
</dt>
<dt><a href="apiref.html#nghttp2_submit_window_update">nghttp2_submit_window_update (C function)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_VERSION">NGHTTP2_VERSION (C macro)</a>
</dt>
<dt><a href="apiref.html#NGHTTP2_WINDOW_UPDATE">NGHTTP2_WINDOW_UPDATE (C macro)</a>
</dt>
<dt><a href="apiref.html#nghttp2_window_update">nghttp2_window_update (C type)</a>
</dt>
<dt><a href="apiref.html#nghttp2_window_update.hd">nghttp2_window_update.hd (C member)</a>
</dt>
<dt><a href="apiref.html#nghttp2_window_update.window_size_increment">nghttp2_window_update.window_size_increment (C member)</a>
</dt>
</dl></td>
</tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/tatsuhiro-t/nghttp2/issues">Issues</a></li>
<li><a href="https://github.com/tatsuhiro-t/nghttp2">Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, 2013, Tatsuhiro Tsujikawa.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
\ No newline at end of file
index.html 0 → 100644
View file @ c6d958c9
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>nghttp2 - HTTP/2.0 C Library &mdash; nghttp2 0.1.0-DEV documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/default2.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0-DEV',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="#" />
<link rel="next" title="nghttp2 - HTTP/2.0 C Library" href="package_README.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="package_README.html" title="nghttp2 - HTTP/2.0 C Library"
accesskey="N">next</a> |</li>
<li><a href="#">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="nghttp2-http-2-0-c-library">
<h1>nghttp2 - HTTP/2.0 C Library<a class="headerlink" href="#nghttp2-http-2-0-c-library" title="Permalink to this headline"></a></h1>
<p>This is an experimental implementation of Hypertext Transfer Protocol
version 2.0.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="package_README.html">nghttp2 - HTTP/2.0 C Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#development-status">Development Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#build-from-git">Build from git</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#building-documentation">Building documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="package_README.html#client-server-and-proxy-programs">Client, Server and Proxy programs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#includes">Includes</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#remarks">Remarks</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#macros">Macros</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#enums">Enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#types-structs-unions-and-typedefs">Types (structs, unions and typedefs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiref.html#functions">Functions</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="resources">
<h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-04">http://tools.ietf.org/html/draft-ietf-httpbis-http2-04</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/tatsuhiro-t/nghttp2/issues">Issues</a></li>
<li><a href="https://github.com/tatsuhiro-t/nghttp2">Source</a></li>
</ul>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">nghttp2 - HTTP/2.0 C Library</a><ul>
<li><a class="reference internal" href="#resources">Resources</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="package_README.html"
title="next chapter">nghttp2 - HTTP/2.0 C Library</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="package_README.html" title="nghttp2 - HTTP/2.0 C Library"
>next</a> |</li>
<li><a href="#">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, 2013, Tatsuhiro Tsujikawa.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
\ No newline at end of file
objects.inv 0 → 100644
View file @ c6d958c9
File added
package_README.html 0 → 100644
View file @ c6d958c9
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>nghttp2 - HTTP/2.0 C Library &mdash; nghttp2 0.1.0-DEV documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/default2.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0-DEV',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="index.html" />
<link rel="next" title="API Reference" href="apiref.html" />
<link rel="prev" title="nghttp2 - HTTP/2.0 C Library" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="apiref.html" title="API Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="nghttp2 - HTTP/2.0 C Library"
accesskey="P">previous</a> |</li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="nghttp2-http-2-0-c-library">
<h1>nghttp2 - HTTP/2.0 C Library<a class="headerlink" href="#nghttp2-http-2-0-c-library" title="Permalink to this headline"></a></h1>
<p>This is an experimental implementation of Hypertext Transfer Protocol
version 2.0.</p>
<div class="section" id="development-status">
<h2>Development Status<a class="headerlink" href="#development-status" title="Permalink to this headline"></a></h2>
<p>We started to implement HTTP-defat-04/2.0
(<a class="reference external" href="http://tools.ietf.org/html/draft-ietf-httpbis-http2-04">http://tools.ietf.org/html/draft-ietf-httpbis-http2-04</a>) based on
spdylay code base.</p>
<p>The following features are not implemented:</p>
<ul class="simple">
<li>Header continuation</li>
<li>ALPN: instead, NPN is used</li>
<li>HTTP Upgrade dance</li>
</ul>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<p>The following packages are needed to build the library:</p>
<ul class="simple">
<li>pkg-config &gt;= 0.20</li>
<li>zlib &gt;= 1.2.3</li>
</ul>
<p>To build and run the unit test programs, the following packages are
required:</p>
<ul class="simple">
<li>cunit &gt;= 2.1</li>
</ul>
<p>To build and run the application programs (<tt class="docutils literal"><span class="pre">nghttp</span></tt>, <tt class="docutils literal"><span class="pre">nghttpd</span></tt> and
<tt class="docutils literal"><span class="pre">nghttpx</span></tt>) in <tt class="docutils literal"><span class="pre">src</span></tt> directory, the following packages are
required:</p>
<ul class="simple">
<li>OpenSSL &gt;= 1.0.1</li>
<li>libevent-openssl &gt;= 2.0.8</li>
</ul>
<p>To enable SPDY protocol in the application program <tt class="docutils literal"><span class="pre">nghttpx</span></tt>, the
following packages are required:</p>
<ul class="simple">
<li>spdylay &gt;= 1.0.0</li>
</ul>
<p>To enable <tt class="docutils literal"><span class="pre">-a</span></tt> option (getting linked assets from the downloaded
resouce) in <tt class="docutils literal"><span class="pre">nghttp</span></tt>, the following
packages are needed:</p>
<ul class="simple">
<li>libxml2 &gt;= 2.7.7</li>
</ul>
<p>If you are using Ubuntu 12.04, you need the following packages
installed:</p>
<ul class="simple">
<li>autoconf</li>
<li>automake</li>
<li>autotools-dev</li>
<li>libtool</li>
<li>pkg-config</li>
<li>zlib1g-dev</li>
<li>libcunit1-dev</li>
<li>libssl-dev</li>
<li>libxml2-dev</li>
<li>libevent-dev</li>
</ul>
<p>spdylay is not packaged in Ubuntu, so you need to build it yourself:
<a class="reference external" href="http://spdylay.sourceforge.net/">http://spdylay.sourceforge.net/</a></p>
</div>
<div class="section" id="build-from-git">
<h2>Build from git<a class="headerlink" href="#build-from-git" title="Permalink to this headline"></a></h2>
<p>Building from git is easy, but please be sure that at least autoconf 2.68 is
used:</p>
<div class="highlight-c"><pre>$ autoreconf -i
$ automake
$ autoconf
$ ./configure
$ make</pre>
</div>
</div>
<div class="section" id="building-documentation">
<h2>Building documentation<a class="headerlink" href="#building-documentation" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Documentation is still incomplete.</p>
</div>
<p>To build documentation, run:</p>
<div class="highlight-c"><pre>$ make html</pre>
</div>
<p>The documents will be generated under <tt class="docutils literal"><span class="pre">doc/manual/html/</span></tt>.</p>
<p>The generated documents will not be installed with <tt class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></tt>.</p>
</div>
<div class="section" id="client-server-and-proxy-programs">
<h2>Client, Server and Proxy programs<a class="headerlink" href="#client-server-and-proxy-programs" title="Permalink to this headline"></a></h2>
<p>The src directory contains HTTP/2.0 client, server and proxy programs.</p>
<div class="section" id="nghttp-client">
<h3>nghttp - client<a class="headerlink" href="#nghttp-client" title="Permalink to this headline"></a></h3>
<p><tt class="docutils literal"><span class="pre">nghttp</span></tt> is HTTP-default04/2.0 client. It can connect to the
HTTP/2.0 server with prior knowledge (without HTTP Upgrade) and NPN in
TLS extension.</p>
<p>By default, it uses SSL/TLS connection. Use <tt class="docutils literal"><span class="pre">--no-tls</span></tt> option to
disable it.</p>
<p>It has verbose output mode for framing information. Here is sample
output from <tt class="docutils literal"><span class="pre">nghttp</span></tt> client:</p>
<div class="highlight-c"><pre>$ src/nghttp -nv https://localhost:3000/
[ 0.000] NPN select next protocol: the remote server offers:
* HTTP-draft-04/2.0
* spdy/3
* spdy/2
* http/1.1
NPN selected the protocol: HTTP-draft-04/2.0
[ 0.005] send SETTINGS frame &lt;length=0, flags=0, stream_id=0&gt;
(niv=0)
[ 0.005] send HEADERS frame &lt;length=58, flags=5, stream_id=1&gt;
; END_STREAM | END_HEADERS
; Open new stream
:host: localhost:3000
:method: GET
:path: /
:scheme: https
accept: */*
accept-encoding: gzip, deflate
user-agent: nghttp2/0.1.0-DEV
[ 0.005] recv SETTINGS frame &lt;length=16, flags=0, stream_id=0&gt;
(niv=2)
[4:100]
[7:65536]
[ 0.005] recv WINDOW_UPDATE frame &lt;length=4, flags=1, stream_id=0&gt;
; END_FLOW_CONTROL
(window_size_increment=0)
[ 0.006] recv HEADERS frame &lt;length=179, flags=4, stream_id=1&gt;
; END_HEADERS
; First response header
:status: 200 OK
accept-ranges: bytes
content-encoding: gzip
content-length: 56
content-type: text/html
date: Sat, 27 Jul 2013 12:08:56 GMT
etag: "cf405c-2d-45adabdf282c0"
last-modified: Tue, 04 Nov 2008 10:44:03 GMT
server: Apache/2.2.22 (Debian)
vary: Accept-Encoding
via: 1.1 nghttpx
[ 0.006] recv DATA frame (length=56, flags=0, stream_id=1)
[ 0.006] recv DATA frame (length=0, flags=1, stream_id=1)
[ 0.006] send GOAWAY frame &lt;length=8, flags=0, stream_id=0&gt;
(last_stream_id=0, error_code=NO_ERROR(0), opaque_data=)</pre>
</div>
</div>
<div class="section" id="nghttpd-server">
<h3>nghttpd - server<a class="headerlink" href="#nghttpd-server" title="Permalink to this headline"></a></h3>
<p><tt class="docutils literal"><span class="pre">nghttpd</span></tt> is static web server. It is single threaded and
multiplexes connections using non-blocking socket.</p>
<p>By default, it uses SSL/TLS connection. Use <tt class="docutils literal"><span class="pre">--no-tls</span></tt> option to
disable it.</p>
<p>Just like <tt class="docutils literal"><span class="pre">nghttp</span></tt>, it has verbose output mode for framing
information. Here is sample output from <tt class="docutils literal"><span class="pre">nghttpd</span></tt> server:</p>
<div class="highlight-c"><pre>$ src/nghttpd 3000 --no-tls -v
IPv4: listen on port 3000
IPv6: listen on port 3000
[id=1] [ 1.020] send SETTINGS frame &lt;length=8, flags=0, stream_id=0&gt;
(niv=1)
[4:100]
[id=1] [ 1.020] closed
[id=2] [ 1.838] send SETTINGS frame &lt;length=8, flags=0, stream_id=0&gt;
(niv=1)
[4:100]
[id=2] [ 1.838] recv SETTINGS frame &lt;length=0, flags=0, stream_id=0&gt;
(niv=0)
[id=2] [ 1.838] recv HEADERS frame &lt;length=58, flags=5, stream_id=1&gt;
; END_STREAM | END_HEADERS
; Open new stream
:host: localhost:3000
:method: GET
:path: /
:scheme: http
accept: */*
accept-encoding: gzip, deflate
user-agent: nghttp2/0.1.0-DEV
[id=2] [ 1.838] send HEADERS frame &lt;length=105, flags=4, stream_id=1&gt;
; END_HEADERS
; First response header
:status: 404 Not Found
content-encoding: gzip
content-type: text/html; charset=UTF-8
date: Sat, 27 Jul 2013 12:32:10 GMT
server: nghttpd nghttp2/0.1.0-DEV
[id=2] [ 1.838] send DATA frame (length=127, flags=0, stream_id=1)
[id=2] [ 1.838] send DATA frame (length=0, flags=1, stream_id=1)
[id=2] [ 1.838] stream_id=1 closed
[id=2] [ 1.839] closed</pre>
</div>
</div>
<div class="section" id="nghttpx-proxy">
<h3>nghttpx - proxy<a class="headerlink" href="#nghttpx-proxy" title="Permalink to this headline"></a></h3>
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> is a multi-threaded reverse proxy for
HTTP-draft-04/2.0, SPDY/HTTPS. It has several operation modes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="33%" />
<col width="11%" />
<col width="31%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Mode option</th>
<th class="head">Frontend</th>
<th class="head">Backend</th>
<th class="head">Note</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>default</td>
<td>HTTP/2.0, SPDY, HTTPS</td>
<td>HTTP/1.1</td>
<td>Reverse proxy</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">--spdy</span></tt></td>
<td>HTTP/2.0, SPDY, HTTPS</td>
<td>HTTP/1.1</td>
<td>SPDY proxy</td>
</tr>
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt></td>
<td>HTTP/2.0, SPDY, HTTPS</td>
<td>HTTP/2.0</td>
<td>SPDY proxy</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">--client</span></tt></td>
<td>HTTP/1.1</td>
<td>HTTP/2.0</td>
<td>1.1 &lt;-&gt; 2.0 conversion</td>
</tr>
<tr class="row-even"><td><tt class="docutils literal"><span class="pre">--client-proxy</span></tt></td>
<td>HTTP/1.1</td>
<td>HTTP/2.0</td>
<td>Forward proxy</td>
</tr>
</tbody>
</table>
<p>The interesting mode at the moment is the default mode. It works like
a reverse proxy and listens HTTP-draft-04/2.0 as well as SPDY and
HTTPS and can be deployed SSL/TLS terminator for existing web server.</p>
<p>By default, it uses SSL/TLS connection for HTTP/2.0 and SPDY. Use
<tt class="docutils literal"><span class="pre">--frontend-spdy--no-tls</span></tt> to disable it in frontend
connection. Likewise, use <tt class="docutils literal"><span class="pre">--backend-spdy-no-tls</span></tt> option to disable
it in backend connection.</p>
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> supports configuration file. See <tt class="docutils literal"><span class="pre">--conf</span></tt> option and
sample configuration file <tt class="docutils literal"><span class="pre">nghttpx.conf.sample</span></tt>.</p>
<p>The <tt class="docutils literal"><span class="pre">nghttpx</span></tt> is ported from <tt class="docutils literal"><span class="pre">shrpx</span></tt> in spdylay project, and it
still has SPDY color in option names. They will be fixed as the
development goes.</p>
<p>Without any of <tt class="docutils literal"><span class="pre">-s</span></tt>, <tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt>, <tt class="docutils literal"><span class="pre">-p</span></tt> and <tt class="docutils literal"><span class="pre">--client</span></tt>
options, <tt class="docutils literal"><span class="pre">nghttpx</span></tt> works as reverse proxy to the backend server:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">SPDY</span><span class="p">,</span> <span class="n">HTTPS</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">Web</span> <span class="n">Server</span>
<span class="p">[</span><span class="n">reverse</span> <span class="n">proxy</span><span class="p">]</span>
</pre></div>
</div>
<p>With <tt class="docutils literal"><span class="pre">-s</span></tt> option, it works as so called secure SPDY proxy:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">SPDY</span><span class="p">,</span> <span class="n">HTTPS</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">Proxy</span>
<span class="p">[</span><span class="n">SPDY</span> <span class="n">proxy</span><span class="p">]</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.,</span> <span class="n">Squid</span><span class="p">)</span>
</pre></div>
</div>
<p>The <tt class="docutils literal"><span class="pre">Client</span></tt> in the above is needs to be configured to use nghttpx as
secure SPDY proxy.</p>
<p>At the time of this writing, Chrome is the only browser which supports
secure SPDY proxy. The one way to configure Chrome to use secure SPDY
proxy is create proxy.pac script like this:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">function</span> <span class="nf">FindProxyForURL</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">host</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="s">&quot;HTTPS SERVERADDR:PORT&quot;</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">SERVERADDR</span></tt> and <tt class="docutils literal"><span class="pre">PORT</span></tt> is the hostname/address and port of the
machine nghttpx is running. Please note that Chrome requires valid
certificate for secure SPDY proxy.</p>
<p>Then run chrome with the following arguments:</p>
<div class="highlight-c"><pre>$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn</pre>
</div>
<p>With <tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt>, it accepts HTTP/2.0, SPDY and HTTPS
connections and communicates with backend in HTTP/2.0:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">SPDY</span><span class="p">,</span> <span class="n">HTTPS</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">Web</span> <span class="n">or</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span> <span class="n">Proxy</span> <span class="n">etc</span>
<span class="p">[</span><span class="n">SPDY</span> <span class="n">bridge</span><span class="p">]</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.,</span> <span class="n">nghttpx</span> <span class="o">-</span><span class="n">s</span><span class="p">)</span>
</pre></div>
</div>
<p>With <tt class="docutils literal"><span class="pre">-p</span></tt> option, it works as forward proxy and expects that the
backend is HTTP/2.0 proxy:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span> <span class="n">Proxy</span>
<span class="p">[</span><span class="n">forward</span> <span class="n">proxy</span><span class="p">]</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.,</span> <span class="n">nghttpx</span> <span class="o">-</span><span class="n">s</span><span class="p">)</span>
</pre></div>
</div>
<p>The <tt class="docutils literal"><span class="pre">Client</span></tt> is needs to be configured to use nghttpx as forward proxy.</p>
<p>With the above configuration, one can use HTTP/1.1 client to access
and test their HTTP/2.0 servers.</p>
<p>With <tt class="docutils literal"><span class="pre">--client</span></tt> option, it works as reverse proxy and expects that
the backend is HTTP/2.0 Web server:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">Web</span> <span class="n">Server</span>
<span class="p">[</span><span class="n">reverse</span> <span class="n">proxy</span><span class="p">]</span>
</pre></div>
</div>
<p>For the operation modes which talk to the backend in HTTP/2.0, the
backend connections can be tunneled though HTTP proxy. The proxy is
specified using <tt class="docutils literal"><span class="pre">--backend-http-proxy-uri</span></tt> option. The following
figure illustrates the example of <tt class="docutils literal"><span class="pre">--spdy-bridge</span></tt> and
<tt class="docutils literal"><span class="pre">--backend-http-proxy-uri</span></tt> option to talk to the outside HTTP/2.0 proxy
through HTTP proxy:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">Client</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">SPDY</span><span class="p">,</span> <span class="n">HTTPS</span><span class="p">)</span> <span class="o">--&gt;</span> <span class="n">nghttpx</span> <span class="o">&lt;--</span> <span class="p">(</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span><span class="p">)</span> <span class="o">--</span>
<span class="p">[</span><span class="n">SPDY</span> <span class="n">bridge</span><span class="p">]</span>
<span class="o">--===================---&gt;</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">2.0</span> <span class="n">Proxy</span>
<span class="p">(</span><span class="n">HTTP</span> <span class="n">proxy</span> <span class="n">tunnel</span><span class="p">)</span> <span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="n">g</span><span class="p">.,</span> <span class="n">nghttpx</span> <span class="o">-</span><span class="n">s</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/tatsuhiro-t/nghttp2/issues">Issues</a></li>
<li><a href="https://github.com/tatsuhiro-t/nghttp2">Source</a></li>
</ul>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">nghttp2 - HTTP/2.0 C Library</a><ul>
<li><a class="reference internal" href="#development-status">Development Status</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#build-from-git">Build from git</a></li>
<li><a class="reference internal" href="#building-documentation">Building documentation</a></li>
<li><a class="reference internal" href="#client-server-and-proxy-programs">Client, Server and Proxy programs</a><ul>
<li><a class="reference internal" href="#nghttp-client">nghttp - client</a></li>
<li><a class="reference internal" href="#nghttpd-server">nghttpd - server</a></li>
<li><a class="reference internal" href="#nghttpx-proxy">nghttpx - proxy</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">nghttp2 - HTTP/2.0 C Library</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="apiref.html"
title="next chapter">API Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/package_README.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="apiref.html" title="API Reference"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="nghttp2 - HTTP/2.0 C Library"
>previous</a> |</li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, 2013, Tatsuhiro Tsujikawa.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
\ No newline at end of file
search.html 0 → 100644
View file @ c6d958c9
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; nghttp2 0.1.0-DEV documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/default2.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.0-DEV',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="nghttp2 0.1.0-DEV documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="search-documentation">Search</h1>
<div id="fallback" class="admonition warning">
<script type="text/javascript">$('#fallback').hide();</script>
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
<p>
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.
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/tatsuhiro-t/nghttp2/issues">Issues</a></li>
<li><a href="https://github.com/tatsuhiro-t/nghttp2">Source</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">nghttp2 0.1.0-DEV documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, 2013, Tatsuhiro Tsujikawa.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
\ No newline at end of file
searchindex.js 0 → 100644
View file @ c6d958c9
Search.setIndex({objects:{"":{NGHTTP2_ERR_INVALID_STATE:[0,0,1,""],NGHTTP2_ERR_FRAME_TOO_LARGE:[0,0,1,""],NGHTTP2_ERR_HEADER_COMP:[0,0,1,""],nghttp2_settings_entry:[0,2,1,""],NGHTTP2_INTERNAL_ERROR:[0,0,1,""],NGHTTP2_PRI_LOWEST:[0,0,1,""],nghttp2_on_frame_recv_callback:[0,2,1,""],NGHTTP2_FLAG_PONG:[0,0,1,""],NGHTTP2_CLIENT_CONNECTION_HEADER_LEN:[0,0,1,""],nghttp2_goaway:[0,2,1,""],NGHTTP2_OPT_NO_AUTO_WINDOW_UPDATE:[0,0,1,""],nghttp2_submit_rst_stream:[0,3,1,""],NGHTTP2_ERR_INVALID_FRAME:[0,0,1,""],nghttp2_frame_type:[0,2,1,""],nghttp2_on_data_recv_callback:[0,2,1,""],nghttp2_select_next_protocol:[0,3,1,""],NGHTTP2_ERR_INVALID_HEADER_BLOCK:[0,0,1,""],nghttp2_session_callbacks:[0,2,1,""],NGHTTP2_ERR_PROTO:[0,0,1,""],NGHTTP2_FRAME_TOO_LARGE:[0,0,1,""],nghttp2_submit_window_update:[0,3,1,""],NGHTTP2_ERR_UNSUPPORTED_VERSION:[0,0,1,""],nghttp2_window_update:[0,2,1,""],NGHTTP2_DATA:[0,0,1,""],nghttp2_frame_hd:[0,2,1,""],NGHTTP2_ERR_INVALID_STREAM_STATE:[0,0,1,""],NGHTTP2_ERR_STREAM_ID_NOT_AVAILABLE:[0,0,1,""],NGHTTP2_STREAM_CLOSED:[0,0,1,""],NGHTTP2_SETTINGS_MAX:[0,0,1,""],nghttp2_headers_category:[0,2,1,""],nghttp2_error_code:[0,2,1,""],NGHTTP2_REFUSED_STREAM:[0,0,1,""],nghttp2_on_data_chunk_recv_callback:[0,2,1,""],NGHTTP2_ERR_START_STREAM_NOT_ALLOWED:[0,0,1,""],nghttp2_strerror:[0,3,1,""],nghttp2_gzip_inflate_del:[0,3,1,""],NGHTTP2_ERR_FATAL:[0,0,1,""],nghttp2_submit_goaway:[0,3,1,""],nghttp2_error:[0,2,1,""],NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE:[0,0,1,""],NGHTTP2_ERR_NOMEM:[0,0,1,""],NGHTTP2_NO_ERROR:[0,0,1,""],NGHTTP2_ERR_DEFERRED:[0,0,1,""],nghttp2_push_promise:[0,2,1,""],NGHTTP2_ERR_TEMPORAL_CALLBACK_FAILURE:[0,0,1,""],nghttp2_session_get_outbound_queue_size:[0,3,1,""],nghttp2_rst_stream:[0,2,1,""],NGHTTP2_PROTO_VERSION_ID_LEN:[0,0,1,""],NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS:[0,0,1,""],nghttp2_data_source_read_callback:[0,2,1,""],NGHTTP2_ERR_WOULDBLOCK:[0,0,1,""],nghttp2_session_resume_data:[0,3,1,""],NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE:[0,0,1,""],NGHTTP2_PRI_DEFAULT:[0,0,1,""],nghttp2_session_server_new:[0,3,1,""],NGHTTP2_FLAG_END_PUSH_PROMISE:[0,0,1,""],NGHTTP2_ERR_INVALID_ARGUMENT:[0,0,1,""],nghttp2_submit_push_promise:[0,3,1,""],NGHTTP2_ERR_GOAWAY_ALREADY_SENT:[0,0,1,""],nghttp2_session_mem_recv:[0,3,1,""],nghttp2_flag:[0,2,1,""],NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS:[0,0,1,""],NGHTTP2_HCAT_REQUEST:[0,0,1,""],nghttp2_ping:[0,2,1,""],nghttp2_gzip:[0,2,1,""],NGHTTP2_FLAG_END_STREAM:[0,0,1,""],NGHTTP2_ERR_EOF:[0,0,1,""],NGHTTP2_HCAT_HEADERS:[0,0,1,""],NGHTTP2_SETTINGS:[0,0,1,""],nghttp2_frame:[0,2,1,""],NGHTTP2_ERR_DEFERRED_DATA_EXIST:[0,0,1,""],NGHTTP2_CANCEL:[0,0,1,""],nghttp2_send_callback:[0,2,1,""],NGHTTP2_ERR_INVALID_STREAM_ID:[0,0,1,""],nghttp2_on_frame_send_callback:[0,2,1,""],nghttp2_session_client_new:[0,3,1,""],NGHTTP2_VERSION:[0,0,1,""],nghttp2_session:[0,2,1,""],NGHTTP2_COMPRESSION_ERROR:[0,0,1,""],NGHTTP2_HCAT_PUSH_RESPONSE:[0,0,1,""],nghttp2_submit_headers:[0,3,1,""],nghttp2_recv_callback:[0,2,1,""],nghttp2_session_get_stream_user_data:[0,3,1,""],NGHTTP2_FLAG_PRIORITY:[0,0,1,""],nghttp2_on_data_send_callback:[0,2,1,""],nghttp2_nv:[0,2,1,""],NGHTTP2_FLAG_END_FLOW_CONTROL:[0,0,1,""],nghttp2_on_unknown_frame_recv_callback:[0,2,1,""],NGHTTP2_ERR_STREAM_CLOSED:[0,0,1,""],nghttp2_opt:[0,2,1,""],NGHTTP2_ERR_CALLBACK_FAILURE:[0,0,1,""],nghttp2_on_invalid_frame_recv_callback:[0,2,1,""],NGHTTP2_FLOW_CONTROL_ERROR:[0,0,1,""],nghttp2_session_set_option:[0,3,1,""],NGHTTP2_ERR_STREAM_CLOSING:[0,0,1,""],nghttp2_session_fail_session:[0,3,1,""],NGHTTP2_PROTO_VERSION_ID:[0,0,1,""],nghttp2_settings_id:[0,2,1,""],NGHTTP2_HEADERS:[0,0,1,""],nghttp2_session_send:[0,3,1,""],NGHTTP2_PROTOCOL_ERROR:[0,0,1,""],nghttp2_gzip_inflate:[0,3,1,""],nghttp2_session_del:[0,3,1,""],nghttp2_settings:[0,2,1,""],nghttp2_on_frame_not_send_callback:[0,2,1,""],nghttp2_submit_data:[0,3,1,""],nghttp2_submit_response:[0,3,1,""],NGHTTP2_CLIENT_CONNECTION_HEADER:[0,0,1,""],NGHTTP2_FLAG_NONE:[0,0,1,""],NGHTTP2_FLAG_END_HEADERS:[0,0,1,""],nghttp2_on_frame_recv_parse_error_callback:[0,2,1,""],nghttp2_submit_settings:[0,3,1,""],NGHTTP2_HCAT_RESPONSE:[0,0,1,""],nghttp2_mem_chunk:[0,2,1,""],nghttp2_priority:[0,2,1,""],nghttp2_session_want_read:[0,3,1,""],NGHTTP2_RST_STREAM:[0,0,1,""],nghttp2_on_stream_close_callback:[0,2,1,""],NGHTTP2_PUSH_PROMISE:[0,0,1,""],nghttp2_data_provider:[0,2,1,""],nghttp2_on_request_recv_callback:[0,2,1,""],nghttp2_session_recv:[0,3,1,""],NGHTTP2_INITIAL_WINDOW_SIZE:[0,0,1,""],NGHTTP2_WINDOW_UPDATE:[0,0,1,""],NGHTTP2_SETTINGS_FLOW_CONTROL_OPTIONS:[0,0,1,""],nghttp2_session_want_write:[0,3,1,""],nghttp2_submit_priority:[0,3,1,""],nghttp2_headers:[0,2,1,""],nghttp2_before_frame_send_callback:[0,2,1,""],NGHTTP2_PING:[0,0,1,""],NGHTTP2_GOAWAY:[0,0,1,""],NGHTTP2_ERR_GZIP:[0,0,1,""],nghttp2_submit_ping:[0,3,1,""],nghttp2_data_source:[0,2,1,""],NGHTTP2_ERR_STREAM_SHUT_WR:[0,0,1,""],NGHTTP2_PRIORITY:[0,0,1,""],nghttp2_submit_request:[0,3,1,""],nghttp2_gzip_inflate_new:[0,3,1,""]},nghttp2_session_callbacks:{on_invalid_frame_recv_callback:[0,1,1,""],before_frame_send_callback:[0,1,1,""],on_stream_close_callback:[0,1,1,""],on_data_chunk_recv_callback:[0,1,1,""],on_unknown_frame_recv_callback:[0,1,1,""],send_callback:[0,1,1,""],nghttp2_on_frame_recv_parse_error_callback:[0,1,1,""],on_frame_send_callback:[0,1,1,""],on_frame_recv_callback:[0,1,1,""],on_data_send_callback:[0,1,1,""],on_frame_not_send_callback:[0,1,1,""],on_request_recv_callback:[0,1,1,""],on_data_recv_callback:[0,1,1,""],recv_callback:[0,1,1,""]},nghttp2_frame:{push_promise:[0,1,1,""],settings:[0,1,1,""],ping:[0,1,1,""],rst_stream:[0,1,1,""],priority:[0,1,1,""],headers:[0,1,1,""],goaway:[0,1,1,""],window_update:[0,1,1,""],hd:[0,1,1,""]},nghttp2_mem_chunk:{length:[0,1,1,""],data:[0,1,1,""]},nghttp2_data_provider:{source:[0,1,1,""],read_callback:[0,1,1,""]},nghttp2_priority:{pri:[0,1,1,""],hd:[0,1,1,""]},nghttp2_settings_entry:{settings_id:[0,1,1,""],value:[0,1,1,""]},nghttp2_window_update:{hd:[0,1,1,""],window_size_increment:[0,1,1,""]},nghttp2_frame_hd:{stream_id:[0,1,1,""],length:[0,1,1,""],type:[0,1,1,""],flags:[0,1,1,""]},nghttp2_ping:{hd:[0,1,1,""]},nghttp2_rst_stream:{error_code:[0,1,1,""],hd:[0,1,1,""]},nghttp2_nv:{valuelen:[0,1,1,""],namelen:[0,1,1,""],name:[0,1,1,""],value:[0,1,1,""]},nghttp2_headers:{nvlen:[0,1,1,""],pri:[0,1,1,""],hd:[0,1,1,""],nva:[0,1,1,""]},nghttp2_goaway:{opaque_data:[0,1,1,""],error_code:[0,1,1,""],opaque_data_len:[0,1,1,""],hd:[0,1,1,""],last_stream_id:[0,1,1,""]},nghttp2_data_source:{fd:[0,1,1,""],ptr:[0,1,1,""]},nghttp2_push_promise:{promised_stream_id:[0,1,1,""],nvlen:[0,1,1,""],nva:[0,1,1,""],hd:[0,1,1,""]},nghttp2_settings:{niv:[0,1,1,""],hd:[0,1,1,""],iv:[0,1,1,""]}},terms:{all:0,code:[0,1],on_unknown_frame_recv_callback:0,illustr:1,nghttp2_err_start_stream_not_allow:0,my_obj:0,nghttp2_frame_hd:0,nghttp2_cancel:0,prefix:0,overlap:0,follow:[0,1],ptr:0,categori:0,"const":0,uint8_t:0,unpack:0,send:[0,1],program:[2,1],under:[0,1],sens:0,fatal:0,spec:0,sent:0,sourc:0,string:0,nul:0,"void":0,nghttp2_flag_end_push_promis:0,nghttp2_submit_p:0,failur:0,retriev:0,tri:0,nghttp2_on_frame_recv_callback:0,foo:0,level:0,did:0,list:0,nghttp2_headers_categori:0,settings_id:0,concurr:0,optlen:0,refer:[0,2],prepar:0,pleas:1,prevent:0,on_stream_close_callback:0,"0x1":0,"0x4":0,zero:0,pass:0,download:1,further:0,port:1,settings_flow_control_opt:0,neg:0,invok:0,current:0,version:[0,1,2],"new":[0,1],net:1,on_invalid_ctrl_recv_callback:0,"public":0,nghttp2_session_resume_data:0,on_ctrl_recv_callback:0,gener:[0,1],onli:[0,1],here:[0,1],closur:0,met:0,nghttp2_rst_stream:0,ubuntu:1,nghttp2_opt_no_auto_window_upd:0,depend:0,becom:0,modifi:1,sinc:0,valu:0,nextprotoneg:0,remark:[0,2],convers:1,anymor:0,step:0,autoreconf:1,queue:0,prior:1,behav:0,nghttp2_submit_prior:0,aka:0,nghttp2_err_gzip:0,nghttp2_frame:0,nghttp2_err_goaway_already_s:0,appli:0,transit:0,prefer:0,put:0,api:[0,2],org:[0,1,2],instal:1,should:0,"byte":[0,1],select:[0,1],from:[0,1,2],describ:0,would:0,memori:0,upgrad:1,next:[0,1],call:[0,1],asset:1,nghttp2_nv:0,nghttp2_on_invalid_frame_recv_callback:0,nghttp2_version:0,type:[0,1,2],until:0,reorder:0,more:0,goawai:[0,1],nghttp2_set:0,nghttp2_pri_default:0,rst_stream:0,inflater_ptr:0,user_data:0,flag:[0,1],accept:1,nghttp2_submit_window_upd:0,known:0,hold:0,nghttp2_err_wouldblock:0,must:0,endpoint:0,word:0,tunnel:1,nghttp2_settings_id:0,work:1,stream_user_data:0,dev:1,nghttp2_session_fail_sess:0,remain:0,can:[0,1],http2:[2,1],could:0,control:0,defer:0,stream:[0,1],give:0,process:0,indic:0,abort:0,want:0,incom:0,nghttp2_header:0,pong:0,nghttp2_err_invalid_stream_st:0,unsign:0,occur:0,nghttp2_settings_flow_control_opt:0,alwai:0,multipl:0,secur:1,anoth:0,charset:1,ping:0,nghttp2_flag_non:0,write:1,nghttp2_err_fat:0,pair:0,sever:[0,1],serveraddr:1,reject:0,sec9:0,instead:[0,1],simpl:0,updat:0,nghttp2_on_request_recv_callback:0,npn:[0,1],resourc:[0,2],default04:1,after:0,spdylai:1,nghttp2_session_get_pri_lowest:0,befor:0,mai:0,nghttp2_compression_error:0,alloc:0,autotool:1,nghttp2_err_frame_too_larg:0,opaqu:0,nvlen:0,element:0,issu:0,nghttp2_flag_prior:0,ssize_t:0,nghttp2_session_want_read:0,order:0,talk:1,includ:[0,2],frontend:1,nghttp2_err_stream_shut_wr:0,hypertext:[2,1],move:0,becaus:0,libcunit1:1,through:1,untouch:0,size_t:0,nghttp2_err_unsupported_vers:0,still:[0,1],mainli:0,paramet:0,typedef:[0,2],fix:1,precondit:0,max_outlen:0,nghttp2_hcat_push_respons:0,window:0,pend:0,nghttp2_err_eof:0,hidden:0,therefor:0,nghttp2_session_send:0,inlen:0,valuelen:0,recept:0,them:0,"return":[0,1],thei:[0,1],nghttp2_push_promis:0,nghttp2_goawai:0,initi:0,"break":0,nghttp2_initial_max_concurrent_stream:0,nghttp2_submit_head:0,promis:0,nov:1,choic:0,document:[2,1],name:[0,1],nghttp2_err_callback_failur:0,nghttp2_send_callback:0,nghttp2_frame_typ:0,no_error:1,drop:0,achiev:0,nghttp2_flow_control_error:0,mode:1,each:0,debug:0,fulli:0,side:0,trailer:0,mean:0,protocol_error:0,chunk:0,continu:1,nghttp2_err_temporal_callback_failur:0,"static":[0,1],connect:[0,1],http:[0,1,2],beyond:0,todo:0,out:0,goe:1,req:0,payload:0,end_flow_control:[0,1],etag:1,suitabl:0,on_ctrl_not_send_callback:0,nghttp2_client_connection_header_len:0,got:0,on_frame_not_send_callback:0,recv_callback:0,end_stream:[0,1],proxi:[2,1],state:0,nghttp2_internal_error:0,free:0,reason:0,base:1,inflat:0,usual:0,releas:0,nghttp2_session_mem_recv:0,nghttp2_flag:0,recv:1,spdy:[0,1],thread:1,syn_repli:0,omit:0,openssl:1,keep:0,length:[0,1],place:0,outsid:[0,1],assign:0,optval:0,first:[0,1],oper:[0,1],rang:[0,1],directli:0,arrai:0,number:0,yourself:1,nghttp2_protocol_error:0,alreadi:0,least:[0,1],nghttp2_on_frame_send_callback:0,opaque_data:[0,1],on_frame_recv_callback:0,open:[0,1],primari:0,size:0,prioriti:0,given:0,"long":0,script:1,unknown:0,data_prd:0,nghttp2_session_get_stream_user_data:0,messag:0,on_unknown_ctrl_recv_callback:0,necessarili:0,draft:[0,1,2],too:0,similarli:0,nghttp2_frame_too_larg:0,internal_error:0,conveni:0,"final":0,store:0,low:0,ssl_ctx:0,option:[0,1],tool:[2,1],copi:0,nghttp2_proto_version_id_len:0,specifi:[0,1],nghttp2_client_connection_head:0,pars:0,termin:[0,1],kind:0,scheme:[0,1],provid:0,remov:0,see:[0,1],structur:0,charact:0,project:1,defat:1,entri:0,nghttp2_session_del:0,read_callback:0,danc:1,nghttp2_error:0,"function":[0,1,2],window_size_incr:[0,1],respons:[0,1],pri:0,argument:[0,1],packag:1,increment:0,reserv:0,need:[0,1],exclud:0,nghttp2_on_frame_recv_parse_error_callback:0,sat:1,bitwis:0,outbound:0,callback:0,payloadlen:0,note:[0,1],nghttp2_refused_stream:0,exampl:[0,1],take:0,which:[0,1],noth:0,singl:[0,1],opaque_data_len:0,sure:1,unless:0,allow:0,"enum":[0,2],though:1,object:0,reach:0,settings_max_concurrent_stream:0,nghttp2_hcat_request:0,most:0,nghttp2_flag_pong:0,thi:[0,1,2],nghttp2_before_frame_send_callback:0,nghttp2_error_cod:0,nghttp2_err_stream_id_not_avail:0,don:0,http2_select:0,url:1,doc:1,later:0,request:0,uri:[0,1],doe:0,nghttp2_gzip_inflate_new:0,fact:0,on_invalid_frame_recv_callback:0,text:1,hostnam:1,verbos:1,session:0,pkg:1,protocol:[0,1,2],data:[0,1],absolut:0,nghttp2_submit_push_promis:0,nghttp2_submit_rst_stream:0,refused_stream:0,configur:[0,1],apach:1,figur:1,before_ctrl_send_callback:0,nghttp2_err_invalid_stream_id:0,experiment:[2,1],queu:0,local:0,nghttp2_err_proto:0,syn_stream:0,variou:0,get:[0,1],likewis:1,window_upd:[0,1],outlen:0,end_head:[0,1],ssl:[0,1],settings_initial_window_s:0,cannot:0,nghttp2_data:0,optnam:0,increas:0,nghttpd:1,requir:[0,1,2],before_frame_send_callback:0,nghttp2_no_error:0,nghttp2_submit_respons:0,bar:0,enabl:1,ietf:[2,1],possibl:0,push_promis:0,method:[0,1],nghttp2_err_header_comp:0,stuff:0,nghttp2_strerror:0,contain:[0,1],nghttp2_window_upd:0,nghttp2_gzip_inflate_del:0,user:[0,1],certif:1,set:[0,1],frame:[0,1],knowledg:1,nghttp2_submit_goawai:0,temporarili:0,result:0,arg:0,fail:0,close:[0,1],analog:0,statu:[0,1,2],correctli:0,vari:[0,1],someth:0,written:0,bridg:1,nghttp2_flag_end_flow_control:0,assoc_stream_id:0,nghttp2_on_data_chunk_recv_callback:0,nghttp2_initial_connection_window_s:0,accord:0,kei:0,flow:0,extens:1,entir:0,len:0,last_stream_id:[0,1],nghttp2_ping:0,tue:1,addit:0,bodi:0,cf405c:1,last:[0,1],nghttp2_proto_version_id:0,region:0,nghttp2_session_want_writ:0,against:0,tempor:0,etc:[0,1],agent:1,compression_error:0,on_request_recv_callback:0,browser:1,whole:0,nghttp2_data_provid:0,point:0,color:1,int32_t:0,address:1,rfc2616:0,header:[0,1],nghttp2_prioriti:0,non:[0,1],shutdown:0,path:[0,1],cancel:0,nghttp2_on_frame_not_send_callback:0,nghttp2_session:0,assum:0,backend:1,nghttp2_recv_callback:0,union:[0,2],due:0,been:0,nghttp2_on_data_send_callback:0,trigger:0,interpret:0,interest:1,nghttp2_hcat_head:0,date:1,nghttp2_on_unknown_frame_recv_callback:0,nghttp2_err_nomem:0,nghttp2_session_server_new:0,both:0,nghttp2_opt:0,lib_error_cod:0,ani:[0,1],repres:0,those:0,"case":0,multi:1,subsequ:0,nghttp2_settings_initial_window_s:0,zlib:1,sourceforg:1,defin:0,"while":0,abov:[0,1],error:0,nghttp2_flag_end_stream:0,invoc:0,listen:1,on_data_chunk_recv_callback:0,nghttp2_session_callback:0,helper:0,libxml2:1,squid:1,select_next_proto_cb:0,promised_stream_id:0,inform:1,conf:1,crash:0,flow_control_error:0,ascii:0,pointer:0,frame_too_larg:0,"null":0,develop:[2,1],perform:0,make:[0,1],belong:0,same:0,member:0,pac:1,headlen:0,nghttp2_on_stream_close_callback:0,start:[0,1],complet:0,nghttp2_session_recv:0,context:0,mytyp:0,effect:0,on_ctrl_recv_parse_error_callback:0,nghttp2_err_deferred_data_exist:0,remot:[0,1],moment:1,zlib1g:1,ownership:0,mani:0,build:[2,1],postpon:0,nghttp2_submit_syn_stream:0,niv:[0,1],implement:[0,1,2],"45adabdf282c0":1,lower:0,com:0,nghttp:1,well:1,without:[0,1],client:[0,1,2],uint32_t:0,resouc:1,error_cod:[0,1],nghttp2_data_sourc:0,left:0,end_push_promis:0,nghttp2_err_def:0,nghttp2_submit_set:0,identifi:0,just:[0,1],nghttp2_on_data_recv_callback:0,send_callback:0,nghttp2_gzip_infl:0,via:1,multiplex:1,config:1,on_frame_send_callback:0,previous:0,web:1,"0x8":0,struct:[0,2],easi:1,also:0,priorit:0,except:0,identif:0,haz:0,other:0,input:0,on_data_send_callback:0,nghttp2_select_next_protocol:0,gmt:1,applic:[0,1],format:0,read:0,caller:0,period:0,outlen_ptr:0,nghttp2_session_set_opt:0,know:0,nva:0,bit:0,associ:0,delta_window_s:0,like:[0,1],specif:0,arbitrari:0,uint16_t:0,signal:0,manual:1,html:[0,1,2],nghttp2_pri_lowest:0,server:[0,1,2],nghttp2_flag_end_head:0,tlen:0,have:0,output:1,stream_clos:0,www:0,revers:1,deal:0,hostport:0,nghttp2_session_client_new:0,some:0,back:0,sampl:1,integ:0,librari:[0,1,2],transmiss:0,nonzero:0,lead:0,nghttp2_data_source_read_callback:0,octet:0,per:0,outgo:0,larg:0,unit:1,condit:0,duplic:0,localhost:1,either:0,machin:1,run:1,post:0,inspect:0,chart:0,host:[0,1],found:1,peer:0,major:0,nghttp2_session_get_outbound_queue_s:0,src:1,about:0,actual:0,socket:1,commun:1,inlen_ptr:0,nghttp2_gzip:0,chrome:1,idl:0,nghttp2_submit_data:0,nghttp2_settings_max_concurrent_stream:0,ssl_tlsext_err_ok:0,disabl:1,block:[0,1],on_data_recv_callback:0,nghttp2_settings_entri:0,nghttp2_err_invalid_fram:0,deploi:1,encod:[0,1],automat:0,ssl_ctx_set_next_proto_select_cb:0,automak:1,stream_id:[0,1],empti:0,chang:0,inclus:0,git:[0,1,2],nghttp2_hcat_respons:0,wai:[0,1],transfer:[0,1,2],support:[0,1],submit:0,avail:0,intention:0,nghttp2:[0,1,2],nghttp2_err_stream_clos:0,on_ctrl_send_callback:0,ipv6:1,forward:1,findproxyforurl:1,strictli:0,ipv4:1,lowest:0,head:0,session_ptr:0,gzip:[0,1],unexpect:0,offer:1,jul:1,nghttp2_err_invalid_st:0,content:[2,1],taken:0,link:1,highest:0,buf:0,suppli:0,succe:0,utf:1,nghttp2_stream_clos:0,"default":[0,1],nghttp2_settings_max:0,access:1,googlecod:0,maximum:0,tell:0,asynchron:0,below:0,nghttpx:1,autoconf:1,libev:1,expect:1,nghttp2_initial_window_s:0,featur:1,shrpx:1,creat:[0,1],"int":0,httpbi:[2,1],descriptor:0,"char":0,incomplet:1,exist:[0,1],file:[0,1],nghttp2_err_invalid_header_block:0,macro:[0,2],nghttp2_mem_chunk:0,googl:1,when:0,detail:0,invalid:0,field:0,valid:[0,1],role:0,nghttp2_err_invalid_argu:0,test:1,you:[0,1],libssl:1,sequenc:0,indirectli:0,technot:0,libtool:1,alpn:[0,1],debian:1,receiv:0,cunit:1,eof:0,algorithm:0,directori:1,reliabl:0,mask:0,nghttp2_settings_flag:0,nghttp2_submit_request:0,namelen:0,portion:0,ignor:0,time:[0,1],push:0,deflat:[0,1]},objtypes:{"0":"c:macro","1":"c:member","2":"c:type","3":"c:function"},titles:["API Reference","nghttp2 - HTTP/2.0 C Library","nghttp2 - HTTP/2.0 C Library"],objnames:{"0":["c","macro","C macro"],"1":["c","member","C member"],"2":["c","type","C type"],"3":["c","function","C function"]},filenames:["apiref","package_README","index"]})
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment