The Cutelyst Dispatcher. More...

#include <Cutelyst/Dispatcher>

Inheritance diagram for Cutelyst::Dispatcher:

Public Member Functions
	Dispatcher (QObject *parent=nullptr)
QMap< QString, Controller * >	controllers () const
QVector< DispatchType * >	dispatchers () const
Action *	expandAction (const Context c, Action action) const
Action *	getAction (const QString &name, const QString &nameSpace=QString()) const
Action *	getActionByPath (const QString &path) const
ActionList	getActions (const QString &name, const QString &nameSpace) const
QString	uriForAction (Action *action, const QStringList &captures) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char signal, const QObject receiver, const char *method) const const
bool	disconnect (const QObject receiver, const char method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject watched, QEvent event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName, QPrivateSignal)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
bool	dispatch (Context *c)
bool	forward (Context c, Component component)
bool	forward (Context *c, const QString &opname)
void	prepareAction (Context *c)
void	setupActions (const QVector< Controller * > &controllers, const QVector< DispatchType * > &dispatchers, bool printActions)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Friends
class	Application
class	Context
class	Controller

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)
bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)
bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)
QString	tr (const char sourceText, const char disambiguation, int n)
QString	trUtf8 (const char sourceText, const char disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

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

Definition at line 27 of file dispatcher.h.

Constructor & Destructor Documentation

◆ Dispatcher()

Dispatcher::Dispatcher ( QObject * parent = nullptr )

Constructs a Dispatcher object with the given parent.

Definition at line 23 of file dispatcher.cpp.

References QObject::QObject(), and QObject::parent().

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

◆ ~Dispatcher()

Dispatcher::~Dispatcher ( )

Definition at line 31 of file dispatcher.cpp.

Member Function Documentation

◆ controllers()

QMap< QString, Controller * > Dispatcher::controllers ( ) const

Returns a hash of registered controllers

Definition at line 259 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 117 of file dispatcher.cpp.

References Cutelyst::Controller::_DISPATCH(), QString::arg(), Cutelyst::Action::controller(), Cutelyst::Context::error(), QString::isEmpty(), and Cutelyst::Context::translate().

Referenced by expandAction(), setupActions(), and uriForAction().

◆ dispatchers()

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

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 293 of file dispatcher.cpp.

References Dispatcher().

Referenced by setupActions().

◆ expandAction()

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

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 281 of file dispatcher.cpp.

References Dispatcher(), and dispatch().

◆ forward() [1/2]

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

protected

Used by Application to forward execution to the following Component

Definition at line 133 of file dispatcher.cpp.

References Cutelyst::Context::execute().

◆ forward() [2/2]

bool Dispatcher::forward	(	Context *	c,
		const QString &	opname )

protected

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

Definition at line 141 of file dispatcher.cpp.

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

◆ getAction()

Action * Dispatcher::getAction	(	const QString &	name,
		const QString &	nameSpace = QString() ) const

Returns a named action from a given namespace.

Definition at line 206 of file dispatcher.cpp.

References Dispatcher(), getActionByPath(), and QString::isEmpty().

◆ getActionByPath()

Action * Dispatcher::getActionByPath ( const QString & path ) const

Returns the named action by its full private path.

Definition at line 223 of file dispatcher.cpp.

References Dispatcher(), QString::count(), QString::prepend(), QString::remove(), and QString::startsWith().

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

◆ getActions()

ActionList Dispatcher::getActions	(	const QString &	name,
		const QString &	nameSpace ) const

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

Definition at line 237 of file dispatcher.cpp.

References Dispatcher(), QVector::append(), QString::isEmpty(), QVector::rbegin(), and QVector::rend().

◆ prepareAction()

void Dispatcher::prepareAction ( Context * c )

protected

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

Definition at line 154 of file dispatcher.cpp.

References Dispatcher(), QList::isEmpty(), QString::isEmpty(), and QStringList::join().

◆ 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 36 of file dispatcher.cpp.

References Dispatcher(), QVector::append(), controllers(), dispatch(), dispatchers(), and Cutelyst::DispatchType::inUse().

◆ uriForAction()

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

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 265 of file dispatcher.cpp.

References Dispatcher(), dispatch(), QString::isEmpty(), and QString::isNull().

◆ Application

friend class Application

friend

Definition at line 111 of file dispatcher.h.

◆ Context

friend class Context

friend

Definition at line 112 of file dispatcher.h.

◆ Controller

friend class Controller

friend

Definition at line 113 of file dispatcher.h.

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Dispatcher()

◆ ~Dispatcher()

Member Function Documentation

◆ controllers()

◆ dispatch()

◆ dispatchers()

◆ expandAction()

◆ forward() [1/2]

◆ forward() [2/2]

◆ getAction()

◆ getActionByPath()

◆ getActions()

◆ prepareAction()

◆ setupActions()

◆ uriForAction()

Friends And Related Symbol Documentation

◆ Application

◆ Context

◆ Controller