Imported Upstream version 1.46.0
[platform/upstream/nghttp2.git] / doc / nghttp2_check_path.rst
1
2 nghttp2_check_path
3 ==================
4
5 Synopsis
6 --------
7
8 *#include <nghttp2/nghttp2.h>*
9
10 .. function:: int nghttp2_check_path(const uint8_t *value, size_t len)
11
12     
13     Returns nonzero if the *value* which is supposed to be the value of
14     the :path header field is valid according to
15     https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.3
16     
17     *value* is valid if it merely consists of the allowed characters.
18     In particular, it does not check whether *value* follows the syntax
19     of path.  The allowed characters are all characters valid by
20     `nghttp2_check_header_value` minus SPC and HT.