Abstract class to described a dispatch type. More...

#include <Cutelyst/DispatchType>

Inheritance diagram for Cutelyst::DispatchType:

[legend]

Public Types
enum	MatchType { NoMatch , PartialMatch , ExactMatch }
Public Types inherited from QObject
enum	TimerId

Public Member Functions
	DispatchType (QObject *parent=nullptr)
virtual	~DispatchType ()
virtual Action *	expandAction (const Context c, Action action) const
virtual bool	inUse ()=0
virtual bool	isLowPrecedence () const
virtual QByteArray	list () const =0
virtual MatchType	match (Context *c, QStringView path, const QStringList &args) const =0
virtual bool	registerAction (Action *action)
virtual QString	uriForAction (Action *action, const QStringList &captures) const =0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject watched, QEvent event)
T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const
T	findChild (Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQmlExposed () const const
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
void	killTimer (Qt::TimerId id)
virtual const QMetaObject *	metaObject () const const
bool	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	setupMatchedAction (Context c, Action action) const
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	Dispatcher

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)
Public Attributes inherited from QObject
	Invalid
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

This abstract class can be used to describe a dispatch type.

Definition at line 24 of file dispatchtype.h.

Member Enumeration Documentation

◆ MatchType

enum Cutelyst::DispatchType::MatchType

This enum is used to describe the kind of a match

Definition at line 29 of file dispatchtype.h.

Constructor & Destructor Documentation

◆ DispatchType()

DispatchType::DispatchType ( QObject * parent = nullptr )

explicit

Construct a new DispatchType object with the given parent.

Definition at line 11 of file dispatchtype.cpp.

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

Referenced by Cutelyst::DispatchTypeChained::DispatchTypeChained(), and Cutelyst::DispatchTypePath::DispatchTypePath().

◆ ~DispatchType()

DispatchType::~DispatchType ( )

virtual

Destroys the DispatchType object.

Definition at line 16 of file dispatchtype.cpp.

Member Function Documentation

◆ expandAction()

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

nodiscardvirtual

Expand the action to a list of actions which is used in chained. The default implementation does nothing and returns a nullptr.

Reimplemented in Cutelyst::DispatchTypeChained.

Definition at line 20 of file dispatchtype.cpp.

Referenced by match().

◆ inUse()

virtual bool Cutelyst::DispatchType::inUse ( )

pure virtual

If false the dispatcher will be unregistered for performance reasons. This method can be used to prepare actions for dispatcher as in a Chain of Actions there is no garantee of registering order.

In the common case if the dispatcher has registered any action, or in some special case that it doesn't need actions it will return true.

Implemented in Cutelyst::DispatchTypeChained, and Cutelyst::DispatchTypePath.

References isLowPrecedence(), and setupMatchedAction().

◆ isLowPrecedence()

bool DispatchType::isLowPrecedence ( ) const

virtual

Returns true if the dispatch type has low precedence when the precedence is the same the Class name is used to sort them.

The default implementation return false.

Definition at line 40 of file dispatchtype.cpp.

Referenced by inUse().

◆ list()

virtual QByteArray Cutelyst::DispatchType::list ( ) const

pure virtual

Lists the registered actions. Has to be implemented by subclasses.

Implemented in Cutelyst::DispatchTypeChained, and Cutelyst::DispatchTypePath.

◆ match()

virtual MatchType Cutelyst::DispatchType::match	(	Context *	c,
		QStringView	path,
		const QStringList &	args ) const

nodiscardpure virtual

Returns the MatchType for the given path and args. Has to be implemented by subclasses.

Implemented in Cutelyst::DispatchTypeChained, and Cutelyst::DispatchTypePath.

References expandAction(), registerAction(), and uriForAction().

◆ registerAction()

bool DispatchType::registerAction ( Action * action )

virtual

Register an action and return true on success. The default implementation does nothing and returns always true.

Reimplemented in Cutelyst::DispatchTypeChained, and Cutelyst::DispatchTypePath.

Definition at line 34 of file dispatchtype.cpp.

Referenced by match().

◆ setupMatchedAction()

void DispatchType::setupMatchedAction	(	Context *	c,
		Action *	action ) const

protected

Sets the matched action to the Context c.

Definition at line 45 of file dispatchtype.cpp.

References Cutelyst::Context::action.

Referenced by inUse(), Cutelyst::DispatchTypeChained::match(), and Cutelyst::DispatchTypePath::match().

◆ uriForAction()

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

nodiscardpure virtual

Returns an uri for an action with given captures. Has to be implemented by subclasses.

Implemented in Cutelyst::DispatchTypeChained, and Cutelyst::DispatchTypePath.

Definition at line 27 of file dispatchtype.cpp.

Referenced by match().

◆ Application

friend class Application

friend

Definition at line 101 of file dispatchtype.h.

◆ Dispatcher

friend class Dispatcher

friend

Definition at line 100 of file dispatchtype.h.

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MatchType

Constructor & Destructor Documentation

◆ DispatchType()

◆ ~DispatchType()

Member Function Documentation

◆ expandAction()

◆ inUse()

◆ isLowPrecedence()

◆ list()

◆ match()

◆ registerAction()

◆ setupMatchedAction()

◆ uriForAction()

Friends And Related Symbol Documentation

◆ Application

◆ Dispatcher