File: overview.rst

package info (click to toggle)
python-qemu-qmp 0.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 564 kB
  • sloc: python: 2,819; makefile: 157; sh: 2
file content (111 lines) | stat: -rw-r--r-- 2,017 bytes parent folder | download | duplicates (2)
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
Overview
========

.. Normally, I'd use automodule to document the whole file, but we want
   different options for each of the entities that show up on this page,
   so I'm doing it manually. There's a risk of bitrot here.

.. automodule:: qemu.qmp
   :noindex:


Classes
-------

.. Adding the names as header entries is a bit redundant, but it makes
   the HTML sidebar a bit nicer.

QMPClient
~~~~~~~~~

.. Show the methods inherited from Protocol, too.
.. autoclass:: qemu.qmp.QMPClient
   :noindex:
   :members:
   :undoc-members:
   :inherited-members:
   :show-inheritance:
   :member-order: bysource


Message
~~~~~~~

.. No need to show the well-known dict methods here.
.. autoclass:: qemu.qmp.Message
   :noindex:
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource


EventListener
~~~~~~~~~~~~~

.. autoclass:: qemu.qmp.EventListener
   :noindex:
   :members:
   :undoc-members:
   :inherited-members:
   :member-order: bysource


Runstate
~~~~~~~~

.. autoclass:: qemu.qmp.Runstate
   :noindex:
   :members:
   :undoc-members:
   :inherited-members:
   :show-inheritance:
   :member-order: bysource


Exceptions
----------

.. autoexception:: qemu.qmp.QMPError
   :noindex:
   :members:
   :undoc-members:
   :inherited-members: Exception
   :show-inheritance:
   :member-order: bysource


.. autoexception:: qemu.qmp.StateError
   :noindex:
   :members:
   :undoc-members:
   :inherited-members: Exception
   :show-inheritance:
   :member-order: bysource


.. autoexception:: qemu.qmp.ConnectError
   :noindex:
   :members:
   :undoc-members:
   :inherited-members: Exception
   :show-inheritance:
   :member-order: bysource


.. autoexception:: qemu.qmp.ExecuteError
   :noindex:
   :members:
   :undoc-members:
   :inherited-members: Exception
   :show-inheritance:
   :member-order: bysource


.. autoexception:: qemu.qmp.ExecInterruptedError
   :noindex:
   :members:
   :undoc-members:
   :inherited-members: Exception
   :show-inheritance:
   :member-order: bysource