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