QEMU Monitor Protocol Library
0.0.3

Home

  • qemu.qmp: QEMU Monitor Protocol Library
    • Who is this library for?
    • Who isn’t this library for?
    • Installing
    • Usage
    • Contributing
      • Developing
    • Stability and Versioning
    • Changelog
      • 0.0.3 (2023-07-10)
      • 0.0.2 (2022-08-26)
      • 0.0.1 (2022-07-20)

Documentation

  • Overview
    • Classes
      • QMPClient
      • Message
      • EventListener
      • Runstate
    • Exceptions

Module Reference

  • Error classes
    • QMPError
    • ProtocolError
      • ProtocolError.error_message
  • Events
    • EventListener Tutorial
      • listener() context blocks with one name
      • listener() context blocks with two or more names
      • listener() context blocks with no names
      • Using async iterators to retrieve events
      • Using asyncio.Task to concurrently retrieve events
      • Using register_listener() and remove_listener()
      • Using the built-in all events listener
      • Using both .get() and async iterators
      • Creating multiple listeners
      • Clearing listeners
      • Accessing listener history
      • Using event filters
      • Activating an existing listener with listen()
      • Activating multiple existing listeners with listen()
      • Extending the EventListener class
    • Experimental Interfaces & Design Issues
      • qmp.listen()’s type signature
    • API Reference
    • EventListener
      • EventListener.accept()
      • EventListener.clear()
      • EventListener.empty()
      • EventListener.event_filter
      • EventListener.get()
      • EventListener.history
      • EventListener.names
      • EventListener.put()
    • Events
      • Events.events
      • Events.listen()
      • Events.listener()
      • Events.register_listener()
      • Events.remove_listener()
    • ListenerError
  • Legacy API
    • QEMUMonitorProtocol
      • QEMUMonitorProtocol.accept()
      • QEMUMonitorProtocol.clear_events()
      • QEMUMonitorProtocol.close()
      • QEMUMonitorProtocol.cmd()
      • QEMUMonitorProtocol.cmd_obj()
      • QEMUMonitorProtocol.command()
      • QEMUMonitorProtocol.connect()
      • QEMUMonitorProtocol.get_events()
      • QEMUMonitorProtocol.parse_address()
      • QEMUMonitorProtocol.pull_event()
      • QEMUMonitorProtocol.send_fd_scm()
      • QEMUMonitorProtocol.settimeout()
    • QMPBadPortError
    • QMPMessage
    • QMPObject
    • QMPReturnValue
  • QMP Messages
    • Message
    • DeserializationError
      • DeserializationError.raw
    • UnexpectedTypeError
      • UnexpectedTypeError.value
    • QMP Data Models
      • Model
      • Greeting
        • Greeting.QMP
      • QMPGreeting
        • QMPGreeting.version
        • QMPGreeting.capabilities
      • ErrorResponse
        • ErrorResponse.error
        • ErrorResponse.id
      • ErrorInfo
        • ErrorInfo.class_
        • ErrorInfo.desc
  • Asyncio Protocol
    • Runstate
      • Runstate.IDLE
      • Runstate.CONNECTING
      • Runstate.RUNNING
      • Runstate.DISCONNECTING
    • ConnectError
      • ConnectError.error_message
      • ConnectError.exc
    • StateError
    • require()
    • AsyncProtocol
      • AsyncProtocol.logger
      • AsyncProtocol._limit
      • AsyncProtocol._dc_task
      • AsyncProtocol.name
      • AsyncProtocol.runstate
      • AsyncProtocol.runstate_changed()
      • AsyncProtocol.start_server_and_accept()
      • AsyncProtocol.start_server()
      • AsyncProtocol.accept()
      • AsyncProtocol.connect()
      • AsyncProtocol.disconnect()
      • AsyncProtocol._session_guard()
      • AsyncProtocol._runstate_event
      • AsyncProtocol._set_state()
      • AsyncProtocol._stop_server()
      • AsyncProtocol._incoming()
      • AsyncProtocol._do_start_server()
      • AsyncProtocol._do_accept()
      • AsyncProtocol._do_connect()
      • AsyncProtocol._establish_session()
      • AsyncProtocol._schedule_disconnect()
      • AsyncProtocol._wait_disconnect()
      • AsyncProtocol._cleanup()
      • AsyncProtocol._bh_disconnect()
      • AsyncProtocol._bh_flush_writer()
      • AsyncProtocol._bh_close_stream()
      • AsyncProtocol._bh_loop_forever()
      • AsyncProtocol._bh_send_message()
      • AsyncProtocol._bh_recv_message()
      • AsyncProtocol._cb_outbound()
      • AsyncProtocol._cb_inbound()
      • AsyncProtocol._readline()
      • AsyncProtocol._do_recv()
      • AsyncProtocol._recv()
      • AsyncProtocol._do_send()
      • AsyncProtocol._send()
      • AsyncProtocol._on_message()
  • QMP Protocol
    • GreetingError
    • NegotiationError
    • ExecuteError
      • ExecuteError.sent
      • ExecuteError.received
      • ExecuteError.error
      • ExecuteError.error_class
    • ExecInterruptedError
    • ServerParseError
    • BadReplyError
      • BadReplyError.sent
    • QMPClient
      • QMPClient.logger
      • QMPClient.await_greeting
      • QMPClient.negotiate
      • QMPClient.greeting
      • QMPClient.execute_msg()
      • QMPClient.make_execute_msg()
      • QMPClient.execute()
      • QMPClient.send_fd_scm()
      • QMPClient.events
  • Utilities
    • flush()
    • upper_half()
    • bottom_half()
    • exception_summary()
    • pretty_traceback()

Tool Reference

  • qmp-shell
    • Usage
    • Syntax
    • Transactions
    • Commands
    • Events
    • Display options
  • qmp-shell-wrap
    • Usage
QEMU Monitor Protocol Library
  • Overview: module code

All modules for which code is available

  • builtins
  • qemu.qmp.error
  • qemu.qmp.events
  • qemu.qmp.legacy
  • qemu.qmp.message
  • qemu.qmp.models
  • qemu.qmp.protocol
  • qemu.qmp.qmp_client
  • qemu.qmp.util

© Copyright 2009-2024, QEMU Project.

Built with Sphinx using a theme provided by Read the Docs.