Fawkes API Fawkes Development Version
plugin-rest-api.h
1
2/***************************************************************************
3 * plugin-rest-api.h - Plugin REST API
4 *
5 * Created: Tue Apr 10 17:08:41 2018
6 * Copyright 2006-2018 Tim Niemueller [www.niemueller.de]
7 ****************************************************************************/
8
9/* This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Library General Public License for more details.
18 *
19 * Read the full text in the LICENSE.GPL file in the doc directory.
20 */
21
22#pragma once
23
24#include "model/Plugin.h"
25#include "model/PluginOpRequest.h"
26#include "model/PluginOpResponse.h"
27
28#include <aspect/logging.h>
29#include <aspect/plugin_director.h>
30#include <aspect/webview.h>
31#include <core/threading/thread.h>
32#include <webview/rest_api.h>
33#include <webview/rest_array.h>
34
35#include <map>
36#include <string>
37
42{
43public:
46
47 virtual void init();
48 virtual void loop();
49 virtual void finalize();
50
51private:
52 WebviewRestArray<::Plugin> cb_list_plugins();
53 PluginOpResponse cb_set_plugin_state(PluginOpRequest &request, fawkes::WebviewRestParams &params);
54
55private:
56 fawkes::WebviewRestApi *rest_api_;
57};
PluginOpRequest representation for JSON transfer.
PluginOpResponse representation for JSON transfer.
REST API backend for plugins.
PluginRestApi()
Constructor.
virtual void loop()
Code to execute in the thread.
virtual void finalize()
Finalize the thread.
~PluginRestApi()
Destructor.
virtual void init()
Initialize the thread.
Container to return array via REST.
Definition: rest_array.h:36
Thread aspect to log output.
Definition: logging.h:33
Thread aspect to access the PluginManager.
Thread class encapsulation of pthreads.
Definition: thread.h:46
Thread aspect to provide web pages via Webview.
Definition: webview.h:37
Webview REST API component.
Definition: rest_api.h:221
REST parameters to pass to handlers.
Definition: rest_api.h:125