The Cutelyst Engine. More...

#include <Cutelyst/Engine>

Inheritance diagram for Cutelyst::Engine:

[legend]

Signals
void	processRequestAsync (Cutelyst::EngineRequest *request)

Public Member Functions
	Engine (Application *app, int workerCore, const QVariantMap &opts)

virtual	~Engine ()

Application *	app () const

QVariantMap	config (const QString &entity) const

bool	isZeroWorker () const

QVariantMap	opts () const

void	processRequest (EngineRequest *request)

void	setConfig (const QVariantMap &config)

int	workerCore () const

virtual int	workerId () const =0

Static Public Member Functions
static QVariantMap	loadIniConfig (const QString &filename)

static QVariantMap	loadJsonConfig (const QString &filename)

Protected Member Functions
Headers &	defaultHeaders ()

bool	initApplication ()

bool	postForkApplication ()

Friends
class	Application

class	Response

Detailed Description

This class is responsible receiving the request and sending the response. It must be reimplemented by real HTTP engines due some pure virtual methods.

The subclass must create an engine per thread (worker core), if the Application passed to the constructor has a worker core greater than 0 it will issue a new Application instance, failing to do so a fatal error is generated (usually indicating that the Application does not have a Q_INVOKABLE constructor).

Definition at line 19 of file engine.h.

Constructor & Destructor Documentation

◆ Engine()

Engine::Engine	(	Cutelyst::Application *	app,
		int	workerCore,
		const QVariantMap &	opts )

explicit

Constructs an Engine object, where app is the application that might be used to create new instances if workerCore is greater than 1, opts is the options loaded by the engine subclass.

Parameters

app	The application loaded
workerCore	The thread number
opts	The configuation options

Definition at line 42 of file engine.cpp.

References Engine(), app(), opts(), processRequest(), processRequestAsync(), and workerCore().

Referenced by Engine(), app(), config(), defaultHeaders(), initApplication(), opts(), postForkApplication(), processRequest(), processRequestAsync(), setConfig(), and workerCore().

◆ ~Engine()

Engine::~Engine ( )

virtual

Destroys the Engine object.

Definition at line 55 of file engine.cpp.

Member Function Documentation

◆ app()

Application * Engine::app ( ) const

nodiscard

Returns the application associated with this engine.

Definition at line 60 of file engine.cpp.

References Engine().

Referenced by Engine().

◆ config()

QVariantMap Engine::config ( const QString & entity ) const

nodiscard

Returns a map of key value pairs for the configuration entitiy (section) from your application’s configuration file.

See also: Configure your application

Definition at line 122 of file engine.cpp.

References Engine().

Referenced by Cutelyst::MemcachedSessionStore::MemcachedSessionStore(), setConfig(), Cutelyst::CSRFProtection::setup(), Cutelyst::LangSelect::setup(), Cutelyst::Memcached::setup(), Cutelyst::Session::setup(), Cutelyst::StaticCompressed::setup(), and workerId().

◆ defaultHeaders()

Headers & Engine::defaultHeaders ( )

nodiscardprotected

This is the HTTP default response headers that each request gets.

Definition at line 104 of file engine.cpp.

References Engine().

Referenced by processRequestAsync().

◆ initApplication()

bool Engine::initApplication ( )

protected

This method inits the application and calls init on the engine. It must be called on the engine's thread. Returns true on success.

Definition at line 73 of file engine.cpp.

References Engine().

Referenced by Cutelyst::ServerEngine::init(), and processRequestAsync().

◆ isZeroWorker()

bool Cutelyst::Engine::isZeroWorker ( ) const

inlinenodiscard

Returns true if this is the Zero worker, ie if workerId() == 0 and workerCore() == 0.

Note: the value returned from this function is only valid when postFork() is issued.

Definition at line 150 of file engine.h.

References workerCore(), and workerId().

Referenced by workerId().

◆ loadIniConfig()

QVariantMap Engine::loadIniConfig ( const QString & filename )

staticnodiscard

Returns a QVariantMap with the INI parsed from filename.

Definition at line 134 of file engine.cpp.

Referenced by workerId().

◆ loadJsonConfig()

QVariantMap Engine::loadJsonConfig ( const QString & filename )

staticnodiscard

Returns a QVariantMap with the JSON parsed from filename.

Definition at line 158 of file engine.cpp.

Referenced by workerId().

◆ opts()

QVariantMap Engine::opts ( ) const

nodiscard

Returns the engine options set in the constructor.

Definition at line 116 of file engine.cpp.

References Engine().

Referenced by Engine(), and workerId().

◆ postForkApplication()

bool Engine::postForkApplication ( )

protected

Subclasses must be call after the engine forks by the worker thread, if no forking is involved it must be called once the worker thread has started.

For convenience QThread::currentThread() has it's object name set with the worker core number.

Returns: true if the engine should use this process

Definition at line 90 of file engine.cpp.

References Engine().

Referenced by processRequestAsync().

◆ processRequest()

void Engine::processRequest ( EngineRequest * request )

Process the request. The caller must delete the context when the request is finished.

This method allows for engines to keep the Context alive while processing websocket data.

Definition at line 110 of file engine.cpp.

References Engine().

Referenced by Engine(), and workerId().

◆ processRequestAsync

void Cutelyst::Engine::processRequestAsync ( Cutelyst::EngineRequest * request )

signal

Process the requst asynchronous. The caller must delete the context when the request is finished.

This method allows for engines to keep the Context alive while processing websocket data.

References Engine(), defaultHeaders(), initApplication(), and postForkApplication().

Referenced by Engine().

◆ setConfig()

void Engine::setConfig ( const QVariantMap & config )

Sets the configuration to be used by Application.

Definition at line 128 of file engine.cpp.

References Engine(), and config().

Referenced by workerId().

◆ workerCore()

int Engine::workerCore ( ) const

nodiscard

Returns the worker core set when constructing the engine.

Each worker process migth have a number of worker cores (threads), a single process with two worker threads will return 0 and 1 for each of the thread respectively.

Definition at line 67 of file engine.cpp.

References Engine().

Referenced by Engine(), isZeroWorker(), and workerId().

◆ workerId()

virtual int Cutelyst::Engine::workerId ( ) const

nodiscardpure virtual

Reimplement this to get the workerId of the engine subclass, this is the same as processes id.

The id is the number of the spawned engine process, a single process workerId = 0, two process 0 for the first 1 for the second.

Note: The value returned from this function is only valid when postFork() is issued.

Implemented in Cutelyst::ServerEngine.

References config(), isZeroWorker(), loadIniConfig(), loadJsonConfig(), opts(), processRequest(), setConfig(), and workerCore().

Referenced by isZeroWorker().

Friends And Related Symbol Documentation

◆ Application

friend class Application

friend

Definition at line 141 of file engine.h.

◆ Response

friend class Response

friend

Definition at line 142 of file engine.h.

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Engine()

◆ ~Engine()

Member Function Documentation

◆ app()

◆ config()

◆ defaultHeaders()

◆ initApplication()

◆ isZeroWorker()

◆ loadIniConfig()

◆ loadJsonConfig()

◆ opts()

◆ postForkApplication()

◆ processRequest()

◆ processRequestAsync

◆ setConfig()

◆ workerCore()

◆ workerId()

Friends And Related Symbol Documentation

◆ Application

◆ Response