doc/macros.rst

   1
   2 Macros
   3 ======
   4 .. macro:: NGHTTP2_VERSION
   5
   6     Version number of the nghttp2 library release
   7 .. macro:: NGHTTP2_VERSION_NUM
   8
   9     Numerical representation of the version number of the nghttp2 library
  10     release. This is a 24 bit number with 8 bits for major number, 8 bits
  11     for minor and 8 bits for patch. Version 1.2.3 becomes 0x010203.
  12 .. macro:: NGHTTP2_PROTO_VERSION_ID
  13
  14
  15     The protocol version identification string of this library
  16     supports.  This identifier is used if HTTP/2 is used over TLS.
  17 .. macro:: NGHTTP2_PROTO_VERSION_ID_LEN
  18
  19
  20     The length of :macro:`NGHTTP2_PROTO_VERSION_ID`.
  21 .. macro:: NGHTTP2_PROTO_ALPN
  22
  23
  24     The seriazlied form of ALPN protocol identifier this library
  25     supports.  Notice that first byte is the length of following
  26     protocol identifier.  This is the same wire format of `TLS ALPN
  27     extension <https://tools.ietf.org/html/rfc7301>`_.  This is useful
  28     to process incoming ALPN tokens in wire format.
  29 .. macro:: NGHTTP2_PROTO_ALPN_LEN
  30
  31
  32     The length of :macro:`NGHTTP2_PROTO_ALPN`.
  33 .. macro:: NGHTTP2_CLEARTEXT_PROTO_VERSION_ID
  34
  35
  36     The protocol version identification string of this library
  37     supports.  This identifier is used if HTTP/2 is used over cleartext
  38     TCP.
  39 .. macro:: NGHTTP2_CLEARTEXT_PROTO_VERSION_ID_LEN
  40
  41
  42     The length of :macro:`NGHTTP2_CLEARTEXT_PROTO_VERSION_ID`.
  43 .. macro:: NGHTTP2_VERSION_AGE
  44
  45
  46     The age of :type:`nghttp2_info`
  47 .. macro:: NGHTTP2_DEFAULT_WEIGHT
  48
  49
  50     The default weight of stream dependency.
  51 .. macro:: NGHTTP2_MAX_WEIGHT
  52
  53
  54     The maximum weight of stream dependency.
  55 .. macro:: NGHTTP2_MIN_WEIGHT
  56
  57
  58     The minimum weight of stream dependency.
  59 .. macro:: NGHTTP2_MAX_WINDOW_SIZE
  60
  61
  62     The maximum window size
  63 .. macro:: NGHTTP2_INITIAL_WINDOW_SIZE
  64
  65
  66     The initial window size for stream level flow control.
  67 .. macro:: NGHTTP2_INITIAL_CONNECTION_WINDOW_SIZE
  68
  69
  70     The initial window size for connection level flow control.
  71 .. macro:: NGHTTP2_DEFAULT_HEADER_TABLE_SIZE
  72
  73
  74     The default header table size.
  75 .. macro:: NGHTTP2_CLIENT_MAGIC
  76
  77
  78     The client magic string, which is the first 24 bytes byte string of
  79     client connection preface.
  80 .. macro:: NGHTTP2_CLIENT_MAGIC_LEN
  81
  82
  83     The length of :macro:`NGHTTP2_CLIENT_MAGIC`.
  84 .. macro:: NGHTTP2_INITIAL_MAX_CONCURRENT_STREAMS
  85
  86     Default maximum concurrent streams.