• RulesHandler
  • RulesHandler Class

    (nymeaserver::RulesHandler)

    This subclass of JsonHandler processes the JSON requests for the Rules namespace of the JSON-RPC API. More...

    Header: #include <RulesHandler>
    Inherits: JsonHandler

    Public Functions

    RulesHandler(QObject * parent = 0)

    Reimplemented Public Functions

    virtual QString name() const

    Signals

    void RuleActiveChanged(const QVariantMap & params)
    void RuleAdded(const QVariantMap & params)
    void RuleConfigurationChanged(const QVariantMap & params)
    void RuleRemoved(const QVariantMap & params)

    Additional Inherited Members

    Detailed Description

    This subclass of JsonHandler processes the JSON requests for the Rules namespace of the JSON-RPC API.

    This JsonHandler will be created in the JsonRPCServer and used to handle JSON-RPC requests for the Rules namespace of the API.

    See also RuleEngine, JsonHandler, and JsonRPCServer.

    Member Function Documentation

    RulesHandler::RulesHandler(QObject * parent = 0)

    Constructs a new RulesHandler with the given parent.

    [signal] void RulesHandler::RuleActiveChanged(const QVariantMap & params)

    This signal is emitted to the API notifications when a Rule has changed the active status. The params contain the map for the notification.

    [signal] void RulesHandler::RuleAdded(const QVariantMap & params)

    This signal is emitted to the API notifications when a Rule was added. The params contain the map for the notification.

    [signal] void RulesHandler::RuleConfigurationChanged(const QVariantMap & params)

    This signal is emitted to the API notifications when a Rule has changed the configuration. The params contain the map for the notification.

    [signal] void RulesHandler::RuleRemoved(const QVariantMap & params)

    This signal is emitted to the API notifications when a Rule was removed. The params contain the map for the notification.

    [virtual] QString RulesHandler::name() const

    Reimplemented from JsonHandler::name().

    Returns the name of the RulesHandler. In this case Rules.