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
|
hyperframe API
==============
This document provides the hyperframe API.
All frame classes are subclasses of :class:`Frame <hyperframe.frame.Frame>`,
and provide the methods and attributes defined there. Additionally, some frames
use the :class:`Priority <hyperframe.frame.Priority>` and
:class:`Padding <hyperframe.frame.Padding>` mixins, and make the methods and
attributes defined on *those* mixins available as well.
Rather than clutter up the documentation repeatedly documenting those methods
and objects, we explicitly show the inheritance hierarchy of the frames: don't
forget to consult the parent classes before deciding if a method or attribute
you need is not present!
.. autoclass:: hyperframe.frame.Frame
:members:
.. autoclass:: hyperframe.frame.Padding
:members:
.. autoclass:: hyperframe.frame.Priority
:members:
.. autoclass:: hyperframe.frame.DataFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.PriorityFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.RstStreamFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.SettingsFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.PushPromiseFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.PingFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.GoAwayFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.WindowUpdateFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.HeadersFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.ContinuationFrame
:show-inheritance:
:members:
.. autoclass:: hyperframe.frame.ExtensionFrame
:show-inheritance:
:members:
.. autodata:: hyperframe.frame.FRAMES
Exceptions
----------
.. autoclass:: hyperframe.exceptions.HyperframeError
:members:
.. autoclass:: hyperframe.exceptions.UnknownFrameError
:members:
.. autoclass:: hyperframe.exceptions.InvalidPaddingError
:members:
.. autoclass:: hyperframe.exceptions.InvalidFrameError
:members:
.. autoclass:: hyperframe.exceptions.InvalidDataError
:members:
|
