LXR 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 QAPI_QMP_DISPATCH_H
  15#define QAPI_QMP_DISPATCH_H
  16
  17#include "qapi/qmp/qobject.h"
  18#include "qapi/qmp/qdict.h"
  19
  20typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
  21
  22typedef enum QmpCommandOptions
  23{
  24    QCO_NO_OPTIONS = 0x0,
  25    QCO_NO_SUCCESS_RESP = 0x1,
  26} QmpCommandOptions;
  27
  28typedef struct QmpCommand
  29{
  30    const char *name;
  31    QmpCommandFunc *fn;
  32    QmpCommandOptions options;
  33    QTAILQ_ENTRY(QmpCommand) node;
  34    bool enabled;
  35} QmpCommand;
  36
  37typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
  38
  39void qmp_register_command(QmpCommandList *cmds, const char *name,
  40                          QmpCommandFunc *fn, QmpCommandOptions options);
  41void qmp_unregister_command(QmpCommandList *cmds, const char *name);
  42QmpCommand *qmp_find_command(QmpCommandList *cmds, const char *name);
  43QObject *qmp_dispatch(QmpCommandList *cmds, QObject *request);
  44void qmp_disable_command(QmpCommandList *cmds, const char *name);
  45void qmp_enable_command(QmpCommandList *cmds, const char *name);
  46
  47bool qmp_command_is_enabled(const QmpCommand *cmd);
  48const char *qmp_command_name(const QmpCommand *cmd);
  49bool qmp_has_success_response(const QmpCommand *cmd);
  50QObject *qmp_build_error_object(Error *err);
  51
  52typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
  53
  54void qmp_for_each_command(QmpCommandList *cmds, qmp_cmd_callback_fn fn,
  55                          void *opaque);
  56
  57#endif
  58