mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-11-22 08:57:34 +01:00
101 lines
4.0 KiB
C++
101 lines
4.0 KiB
C++
#ifndef WEB_SERVER_H
|
|
#define WEB_SERVER_H
|
|
|
|
/*************************************************************************/
|
|
/* web_server.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* PANDEMONIUM ENGINE */
|
|
/* https://github.com/Relintai/pandemonium_engine */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2022-present Péter Magyar. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#include "core/os/rw_lock.h"
|
|
#include "scene/main/node.h"
|
|
|
|
class WebServerRequest;
|
|
class WebNode;
|
|
class WebRoot;
|
|
class HTTPSessionManager;
|
|
|
|
class WebServer : public Node {
|
|
GDCLASS(WebServer, Node);
|
|
|
|
public:
|
|
enum {
|
|
NOTIFICATION_WEB_SERVER_STARTED = 2000,
|
|
NOTIFICATION_WEB_SERVER_STOPPED = 2001,
|
|
NOTIFICATION_WEB_SERVER_WRITE_LOCK_ACQUIRED = 2002,
|
|
};
|
|
|
|
bool get_is_running();
|
|
|
|
WebNode *get_web_root();
|
|
HTTPSessionManager *get_session_manager();
|
|
|
|
void server_handle_request(Ref<WebServerRequest> request);
|
|
|
|
// The server is expected to be running in a heavily multi threaded setting,
|
|
// if you want to safely change to root, or to heavily change the tree
|
|
// you need to lock the tree, however triggering a change like this using a web interface
|
|
// from within a server would cause a deadlock, so if you want to do something like this
|
|
// you can call request_write_lock() while handling a request, then
|
|
// do the desired change when your node receives NOTIFICATION_WEB_SERVER_WRITE_LOCK_ACQUIRED
|
|
// Also note that every WebNode has a lock similar to this for the same reason,
|
|
// if you want to only change a certain WebNode's children, only lock that particular node.
|
|
void request_write_lock();
|
|
|
|
void refresh_root();
|
|
|
|
void start();
|
|
void stop();
|
|
|
|
virtual void _start();
|
|
virtual void _stop();
|
|
|
|
Dictionary unregister_connection_for_request(const Ref<WebServerRequest> &request);
|
|
virtual Dictionary _unregister_connection_for_request(const Ref<WebServerRequest> &request);
|
|
|
|
String get_configuration_warning() const;
|
|
|
|
WebServer();
|
|
~WebServer();
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
bool _is_running;
|
|
|
|
WebNode *_web_root;
|
|
HTTPSessionManager *_session_manager;
|
|
|
|
bool _write_lock_requested;
|
|
RWLock _rw_lock;
|
|
};
|
|
|
|
#endif
|