qemu/include/qapi/qmp/dispatch.h

   1 /*
   2  * Core Definitions for QAPI/QMP Dispatch
   3  *
   4  * Copyright IBM, Corp. 2011
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  10  * See the COPYING.LIB file in the top-level directory.
  11  *
  12  */
  13
  14 #ifndef QMP_CORE_H
  15 #define QMP_CORE_H
  16
  17 #include "qapi/qmp/qobject.h"
  18 #include "qapi/qmp/qdict.h"
  19
  20 typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
  21
  22 typedef enum QmpCommandType
  23 {
  24     QCT_NORMAL,
  25 } QmpCommandType;
  26
  27 typedef enum QmpCommandOptions
  28 {
  29     QCO_NO_OPTIONS = 0x0,
  30     QCO_NO_SUCCESS_RESP = 0x1,
  31 } QmpCommandOptions;
  32
  33 typedef struct QmpCommand
  34 {
  35     const char *name;
  36     QmpCommandType type;
  37     QmpCommandFunc *fn;
  38     QmpCommandOptions options;
  39     QTAILQ_ENTRY(QmpCommand) node;
  40     bool enabled;
  41 } QmpCommand;
  42
  43 void qmp_register_command(const char *name, QmpCommandFunc *fn,
  44                           QmpCommandOptions options);
  45 QmpCommand *qmp_find_command(const char *name);
  46 QObject *qmp_dispatch(QObject *request);
  47 void qmp_disable_command(const char *name);
  48 void qmp_enable_command(const char *name);
  49 bool qmp_command_is_enabled(const QmpCommand *cmd);
  50 const char *qmp_command_name(const QmpCommand *cmd);
  51 bool qmp_has_success_response(const QmpCommand *cmd);
  52 QObject *qmp_build_error_object(Error *err);
  53 typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
  54 void qmp_for_each_command(qmp_cmd_callback_fn fn, void *opaque);
  55
  56 #endif
  57