Cutelyst::Dispatcher Class Reference

The Cutelyst Dispatcher. More...

#include <Cutelyst/Dispatcher>

Inheritance diagram for Cutelyst::Dispatcher:

Public Member Functions
	Dispatcher (QObject *parent=nullptr)
	~Dispatcher ()
Controller *	controller (QStringView name) const
QList< Controller * >	controllers () const
QVector< DispatchType * >	dispatchers () const
Action *	expandAction (const Context *c, Action *action) const
Action *	getAction (QStringView name, QStringView nameSpace={}) const
Action *	getActionByPath (QStringView path) const
ActionList	getActions (QStringView name, QStringView nameSpace) const
QString	uriForAction (Action *action, const QStringList &captures) const

Protected Member Functions
bool	dispatch (Context *c)
bool	forward (Context *c, Component *component)
bool	forward (Context *c, QStringView opname)
void	prepareAction (Context *c)
void	setupActions (const QVector< Controller * > &controllers, const QVector< DispatchType * > &dispatchers, bool printActions)

Friends
class	Application
class	Context
class	Controller

Detailed Description

This class is resposible for finding an Action for new requests and invoking it.

Definition at line 28 of file dispatcher.h.

Constructor & Destructor Documentation

Dispatcher()

Dispatcher::Dispatcher ( QObject * parent = nullptr )

explicit

Constructs a new Dispatcher object with the given parent.

Definition at line 24 of file dispatcher.cpp.

Referenced by controller(), controllers(), dispatchers(), expandAction(), forward(), getAction(), getActionByPath(), getActions(), prepareAction(), setupActions(), and uriForAction().

~Dispatcher()

Dispatcher::~Dispatcher

(

)

Destroys the Dispatcher object.

Definition at line 32 of file dispatcher.cpp.

Member Function Documentation

controller()

Controller * Dispatcher::controller ( QStringView name ) const

nodiscard

Returns a Controller given it's name.

Definition at line 269 of file dispatcher.cpp.

References Dispatcher().

controllers()

QList< Controller * > Dispatcher::controllers ( ) const

nodiscard

Returns a list of registered controllers.

Definition at line 275 of file dispatcher.cpp.

References Dispatcher().

Referenced by setupActions().

dispatch()

bool Dispatcher::dispatch ( Context * c )

protected

Delegate the dispatch to the action that matched the url, or return a message about unknown resource.

Definition at line 125 of file dispatcher.cpp.

References Cutelyst::Controller::_DISPATCH(), Cutelyst::Context::action, Cutelyst::Context::appendError(), Cutelyst::Action::controller(), Cutelyst::Context::qtTrId(), and Cutelyst::Context::req.

dispatchers()

QVector< DispatchType * > Dispatcher::dispatchers ( ) const

nodiscard

Returns a list of all dispatchers currently in use, if the dispatcher doesn't successfuly register an Action it's removed from the list.

Definition at line 318 of file dispatcher.cpp.

References Dispatcher().

Referenced by setupActions().

expandAction()

Action * Dispatcher::expandAction ( const Context * c, Action * action ) const

nodiscard

Expand an action into a full representation of the dispatch. Mostly useful for chained where the returned Action will be of ActionChain type, other actions will just return a single action.

Definition at line 306 of file dispatcher.cpp.

References Dispatcher(), and Cutelyst::DispatchType::expandAction().

forward() [1/2]

bool Dispatcher::forward ( Context * c, Component * component )

protected

Used by Application to forward execution to the following Component.

Definition at line 143 of file dispatcher.cpp.

References Cutelyst::Context::execute().

forward() [2/2]

bool Dispatcher::forward ( Context * c, QStringView opname )

protected

Used by Application to forward execution to opname that is resolved to an Action.

Definition at line 151 of file dispatcher.cpp.

References Dispatcher(), Cutelyst::Action::dispatch(), and Cutelyst::Context::request.

getAction()

Action * Dispatcher::getAction ( QStringView name, QStringView nameSpace = {} ) const

nodiscard

Returns an action by name from a given nameSpace.

Definition at line 219 of file dispatcher.cpp.

References Dispatcher(), and getActionByPath().

getActionByPath()

Action * Dispatcher::getActionByPath ( QStringView path ) const

nodiscard

Returns an action by its full private path.

Definition at line 235 of file dispatcher.cpp.

References Dispatcher().

Referenced by Cutelyst::RoleACL::dispatcherReady(), and getAction().

getActions()

ActionList Dispatcher::getActions ( QStringView name, QStringView nameSpace ) const

nodiscard

Returns a list of actions that match name on the desired namespace nameSpace.

Definition at line 248 of file dispatcher.cpp.

References Dispatcher().

prepareAction()

void Dispatcher::prepareAction ( Context * c )

protected

Used by Application to find a matching action for the current Context c.

Definition at line 164 of file dispatcher.cpp.

References Dispatcher(), and Cutelyst::Context::request.

setupActions()

void Dispatcher::setupActions ( const QVector< Controller * > & controllers, const QVector< DispatchType * > & dispatchers, bool printActions )

protected

Used by Application to register all Controllers Actions into the list of DispatchType.

Definition at line 37 of file dispatcher.cpp.

References Dispatcher(), controllers(), and dispatchers().

uriForAction()

QString Dispatcher::uriForAction ( Action * action, const QStringList & captures ) const

nodiscard

Takes a Catalyst::Action object and action parameters and returns a URI part such that if $c->req->path were this URI part, this action would be dispatched to with $c->req->captures set to the supplied arrayref.

If the action object is not available for external dispatch or the dispatcher cannot determine an appropriate URI, this method will return a null byte array.

Definition at line 285 of file dispatcher.cpp.

References Dispatcher(), and Cutelyst::DispatchType::uriForAction().

Friends And Related Symbol Documentation

Application

friend class Application

friend

Definition at line 121 of file dispatcher.h.

Context

friend class Context

friend

Definition at line 122 of file dispatcher.h.

Controller

friend class Controller

friend

Definition at line 123 of file dispatcher.h.