tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

api.rst (3170B)

      1 h2 API
      2 ======
      3 
      4 This document details the API of h2.
      5 
      6 Semantic Versioning
      7 -------------------
      8 
      9 h2 follows semantic versioning for its public API. Please note that the
     10 guarantees of semantic versioning apply only to the API that is *documented
     11 here*. Simply because a method or data field is not prefaced by an underscore
     12 does not make it part of h2's public API. Anything not documented here is
     13 subject to change at any time.
     14 
     15 Connection
     16 ----------
     17 
     18 .. autoclass:: h2.connection.H2Connection
     19   :members:
     20   :exclude-members: inbound_flow_control_window
     21 
     22 
     23 Configuration
     24 -------------
     25 
     26 .. autoclass:: h2.config.H2Configuration
     27   :members:
     28 
     29 
     30 .. _h2-events-api:
     31 
     32 Events
     33 ------
     34 
     35 .. autoclass:: h2.events.RequestReceived
     36   :members:
     37 
     38 .. autoclass:: h2.events.ResponseReceived
     39   :members:
     40 
     41 .. autoclass:: h2.events.TrailersReceived
     42   :members:
     43 
     44 .. autoclass:: h2.events.InformationalResponseReceived
     45   :members:
     46 
     47 .. autoclass:: h2.events.DataReceived
     48   :members:
     49 
     50 .. autoclass:: h2.events.WindowUpdated
     51   :members:
     52 
     53 .. autoclass:: h2.events.RemoteSettingsChanged
     54   :members:
     55 
     56 .. autoclass:: h2.events.PingReceived
     57   :members:
     58 
     59 .. autoclass:: h2.events.PingAckReceived
     60   :members:
     61 
     62 .. autoclass:: h2.events.StreamEnded
     63   :members:
     64 
     65 .. autoclass:: h2.events.StreamReset
     66   :members:
     67 
     68 .. autoclass:: h2.events.PushedStreamReceived
     69   :members:
     70 
     71 .. autoclass:: h2.events.SettingsAcknowledged
     72   :members:
     73 
     74 .. autoclass:: h2.events.PriorityUpdated
     75   :members:
     76 
     77 .. autoclass:: h2.events.ConnectionTerminated
     78   :members:
     79 
     80 .. autoclass:: h2.events.AlternativeServiceAvailable
     81   :members:
     82 
     83 .. autoclass:: h2.events.UnknownFrameReceived
     84   :members:
     85 
     86 
     87 Exceptions
     88 ----------
     89 
     90 .. autoclass:: h2.exceptions.H2Error
     91   :members:
     92 
     93 .. autoclass:: h2.exceptions.NoSuchStreamError
     94   :show-inheritance:
     95   :members:
     96 
     97 .. autoclass:: h2.exceptions.StreamClosedError
     98   :show-inheritance:
     99   :members:
    100 
    101 .. autoclass:: h2.exceptions.RFC1122Error
    102   :show-inheritance:
    103   :members:
    104 
    105 
    106 Protocol Errors
    107 ~~~~~~~~~~~~~~~
    108 
    109 .. autoclass:: h2.exceptions.ProtocolError
    110   :show-inheritance:
    111   :members:
    112 
    113 .. autoclass:: h2.exceptions.FrameTooLargeError
    114   :show-inheritance:
    115   :members:
    116 
    117 .. autoclass:: h2.exceptions.FrameDataMissingError
    118   :show-inheritance:
    119   :members:
    120 
    121 .. autoclass:: h2.exceptions.TooManyStreamsError
    122   :show-inheritance:
    123   :members:
    124 
    125 .. autoclass:: h2.exceptions.FlowControlError
    126   :show-inheritance:
    127   :members:
    128 
    129 .. autoclass:: h2.exceptions.StreamIDTooLowError
    130   :show-inheritance:
    131   :members:
    132 
    133 .. autoclass:: h2.exceptions.InvalidSettingsValueError
    134   :members:
    135 
    136 .. autoclass:: h2.exceptions.NoAvailableStreamIDError
    137   :show-inheritance:
    138   :members:
    139 
    140 .. autoclass:: h2.exceptions.InvalidBodyLengthError
    141   :show-inheritance:
    142   :members:
    143 
    144 .. autoclass:: h2.exceptions.UnsupportedFrameError
    145   :members:
    146 
    147 .. autoclass:: h2.exceptions.DenialOfServiceError
    148   :show-inheritance:
    149   :members:
    150 
    151 
    152 HTTP/2 Error Codes
    153 ------------------
    154 
    155 .. automodule:: h2.errors
    156   :members:
    157 
    158 
    159 Settings
    160 --------
    161 
    162 .. autoclass:: h2.settings.SettingCodes
    163   :members:
    164 
    165 .. autoclass:: h2.settings.Settings
    166   :inherited-members:
    167 
    168 .. autoclass:: h2.settings.ChangedSetting
    169   :members: