1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
VILLASnode/include/villas/api.h

91 lines
2.4 KiB
C
Raw Permalink Normal View History

/** REST-API-releated functions.
*
* @file
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
* @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
2017-04-27 12:56:43 +02:00
* @license GNU General Public License (version 3)
*
* VILLASnode
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
2017-04-27 12:56:43 +02:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
2017-04-27 12:56:43 +02:00
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************************/
#pragma once
#include <libwebsockets.h>
#include <jansson.h>
#include <pthread.h>
#include "list.h"
#include "common.h"
#include "queue_signalled.h"
#include "api/session.h"
#ifdef __cplusplus
extern "C"{
#endif
/* Forward declarations */
struct lws;
struct super_node;
struct api;
struct api_action;
/** Callback type of command function
*
* @param[inout] c Command handle
* @param[in] args JSON command arguments.
* @param[out] resp JSON command response.
* @param[in] i Execution context.
*/
typedef int (*api_cb_t)(struct api_action *c, json_t *args, json_t **resp, struct api_session *s);
struct api {
enum state state;
struct list sessions; /**< List of currently active connections */
struct queue_signalled pending; /**< A queue of api_sessions which have pending requests. */
pthread_t thread;
struct super_node *super_node;
};
/** API action descriptor */
struct api_action {
api_cb_t cb;
};
/** Initalize the API.
*
* Save references to list of paths / nodes for command execution.
*/
int api_init(struct api *a, struct super_node *sn);
int api_destroy(struct api *a);
int api_start(struct api *a);
int api_stop(struct api *a);
/** Libwebsockets callback for "api" endpoint */
int api_ws_protocol_cb(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len);
2017-07-24 19:33:35 +02:00
int api_http_protocol_cb(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len);
#ifdef __cplusplus
}
#endif