• JsonRPCServer
  • JsonRPCServer Class

    (nymeaserver::JsonRPCServer)

    This class provides a JSON-RPC API interface to the TransportInterfaces. More...

    Header: #include <JsonRPCServer>
    Inherits: JsonHandler

    Public Functions

    JsonRPCServer(const QSslConfiguration & sslConfiguration = QSslConfiguration(), QObject * parent = nullptr)
    void registerTransportInterface(TransportInterface * interface, bool authenticationRequired)
    void unregisterTransportInterface(TransportInterface * interface)

    Reimplemented Public Functions

    virtual QString name() const

    Signals

    void CloudConnectedChanged(const QVariantMap & map)
    void PushButtonAuthFinished(const QVariantMap & params)

    Additional Inherited Members

    Detailed Description

    This class provides a JSON-RPC API interface to the TransportInterfaces.

    The JsonRPCServer class provides the server interface for a JSON-RPC API call. This class communicates with TransportInterfaces and processes the JSON-RPC request in the corresponding JsonHandler. The JsonRPCServer it self is also an JsonHandler and provides the introspection, version and notification control methods for the JSON-RPC API.

    See also ServerManager, TransportInterface, TcpServer, and WebSocketServer.

    Member Function Documentation

    JsonRPCServer::JsonRPCServer(const QSslConfiguration & sslConfiguration = QSslConfiguration(), QObject * parent = nullptr)

    Constructs a JsonRPCServer with the given sslConfiguration and parent.

    [signal] void JsonRPCServer::CloudConnectedChanged(const QVariantMap & map)

    [signal] void JsonRPCServer::PushButtonAuthFinished(const QVariantMap & params)

    [virtual] QString JsonRPCServer::name() const

    Reimplemented from JsonHandler::name().

    Returns the namespace of JsonHandler.

    void JsonRPCServer::registerTransportInterface(TransportInterface * interface, bool authenticationRequired)

    Register a new TransportInterface to the JSON server. If the given interface is already registered, just the authenticationRequired flag will be updated.

    void JsonRPCServer::unregisterTransportInterface(TransportInterface * interface)