core::RocketsPlugin Class Reference

#include <RocketsPlugin.h>

Inheritance diagram for core::RocketsPlugin:

Collaboration diagram for core::RocketsPlugin:

Classes
class	Impl

Public Member Functions
	~RocketsPlugin ()
void	init () final
void	preRender () final
void	postRender () final
Public Member Functions inherited from core::ExtensionPlugin
virtual	~ExtensionPlugin ()=default

Additional Inherited Members
Protected Attributes inherited from core::ExtensionPlugin
PluginAPI *	_api {nullptr}

Detailed Description

The RocketsPlugin is in charge of exposing a both an http/REST interface to the outside world. The http server is configured according to the –http-server parameter provided by ApplicationParameters.

Definition at line 37 of file RocketsPlugin.h.

Constructor & Destructor Documentation

~RocketsPlugin()

core::RocketsPlugin::~RocketsPlugin

(

)

Definition at line 2213 of file RocketsPlugin.cpp.

Member Function Documentation

init()

void core::RocketsPlugin::init ( )

finalvirtual

Called from Core::Core right after the engine has been created

Reimplemented from core::ExtensionPlugin.

Definition at line 2218 of file RocketsPlugin.cpp.

postRender()

void core::RocketsPlugin::postRender ( )

finalvirtual

Enqueue modified and registered objects for broadcast that have changed after the rendering is finished (framebuffer).

Reimplemented from core::ExtensionPlugin.

Definition at line 2228 of file RocketsPlugin.cpp.

preRender()

void core::RocketsPlugin::preRender ( )

finalvirtual

In case no event loop is available, this processes in- and outgoing HTTP and websocket messages.

Otherwise, this is a NOP as the incoming message processing is done by the SocketListener.

Reimplemented from core::ExtensionPlugin.

Definition at line 2224 of file RocketsPlugin.cpp.

---

The documentation for this class was generated from the following files:

• platform/plugins/rockets/RocketsPlugin.h
• platform/plugins/rockets/RocketsPlugin.cpp