Home | History | Annotate | Download | only in qmp 
      1 /*
      2  * Core Definitions for QAPI/QMP Dispatch
      3  *
      4  * Copyright IBM, Corp. 2011
      5  *
      6  * Authors:
      7  *  Anthony Liguori   <aliguori (at) 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 #include "qapi/error.h"
     20 
     21 typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
     22 
     23 typedef enum QmpCommandType
     24 {
     25     QCT_NORMAL,
     26 } QmpCommandType;
     27 
     28 typedef enum QmpCommandOptions
     29 {
     30     QCO_NO_OPTIONS = 0x0,
     31     QCO_NO_SUCCESS_RESP = 0x1,
     32 } QmpCommandOptions;
     33 
     34 typedef struct QmpCommand
     35 {
     36     const char *name;
     37     QmpCommandType type;
     38     QmpCommandFunc *fn;
     39     QmpCommandOptions options;
     40     QTAILQ_ENTRY(QmpCommand) node;
     41     bool enabled;
     42 } QmpCommand;
     43 
     44 void qmp_register_command(const char *name, QmpCommandFunc *fn,
     45                           QmpCommandOptions options);
     46 QmpCommand *qmp_find_command(const char *name);
     47 QObject *qmp_dispatch(QObject *request);
     48 void qmp_disable_command(const char *name);
     49 void qmp_enable_command(const char *name);
     50 bool qmp_command_is_enabled(const QmpCommand *cmd);
     51 const char *qmp_command_name(const QmpCommand *cmd);
     52 bool qmp_has_success_response(const QmpCommand *cmd);
     53 QObject *qmp_build_error_object(Error *errp);
     54 typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
     55 void qmp_for_each_command(qmp_cmd_callback_fn fn, void *opaque);
     56 
     57 #endif
     58 
     59