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