tor-browser

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

api.rst (2155B)

      1 hyperframe API
      2 ==============
      3 
      4 This document provides the hyperframe API.
      5 
      6 All frame classes are subclasses of :class:`Frame <hyperframe.frame.Frame>`,
      7 and provide the methods and attributes defined there. Additionally, some frames
      8 use the :class:`Priority <hyperframe.frame.Priority>` and
      9 :class:`Padding <hyperframe.frame.Padding>` mixins, and make the methods and
     10 attributes defined on *those* mixins available as well.
     11 
     12 Rather than clutter up the documentation repeatedly documenting those methods
     13 and objects, we explicitly show the inheritance hierarchy of the frames: don't
     14 forget to consult the parent classes before deciding if a method or attribute
     15 you need is not present!
     16 
     17 .. autoclass:: hyperframe.frame.Frame
     18   :members:
     19 
     20 .. autoclass:: hyperframe.frame.Padding
     21   :members:
     22 
     23 .. autoclass:: hyperframe.frame.Priority
     24   :members:
     25 
     26 .. autoclass:: hyperframe.frame.DataFrame
     27   :show-inheritance:
     28   :members:
     29 
     30 .. autoclass:: hyperframe.frame.PriorityFrame
     31   :show-inheritance:
     32   :members:
     33 
     34 .. autoclass:: hyperframe.frame.RstStreamFrame
     35   :show-inheritance:
     36   :members:
     37 
     38 .. autoclass:: hyperframe.frame.SettingsFrame
     39   :show-inheritance:
     40   :members:
     41 
     42 .. autoclass:: hyperframe.frame.PushPromiseFrame
     43   :show-inheritance:
     44   :members:
     45 
     46 .. autoclass:: hyperframe.frame.PingFrame
     47   :show-inheritance:
     48   :members:
     49 
     50 .. autoclass:: hyperframe.frame.GoAwayFrame
     51   :show-inheritance:
     52   :members:
     53 
     54 .. autoclass:: hyperframe.frame.WindowUpdateFrame
     55   :show-inheritance:
     56   :members:
     57 
     58 .. autoclass:: hyperframe.frame.HeadersFrame
     59   :show-inheritance:
     60   :members:
     61 
     62 .. autoclass:: hyperframe.frame.ContinuationFrame
     63   :show-inheritance:
     64   :members:
     65 
     66 .. autoclass:: hyperframe.frame.ExtensionFrame
     67   :show-inheritance:
     68   :members:
     69 
     70 .. autodata:: hyperframe.frame.FRAMES
     71 
     72 Exceptions
     73 ----------
     74 
     75 .. autoclass:: hyperframe.exceptions.HyperframeError
     76   :members:
     77 
     78 .. autoclass:: hyperframe.exceptions.UnknownFrameError
     79   :members:
     80 
     81 .. autoclass:: hyperframe.exceptions.InvalidPaddingError
     82   :members:
     83 
     84 .. autoclass:: hyperframe.exceptions.InvalidFrameError
     85   :members:
     86 
     87 .. autoclass:: hyperframe.exceptions.InvalidDataError
     88   :members: