Cutelyst::Controller Class Reference

Cutelyst Controller base class More...

#include <Cutelyst/Controller>

Inheritance diagram for Cutelyst::Controller:

Public Member Functions
	Controller (QObject *parent=nullptr)
Action *	actionFor (const QString &name) const
Action *	actionFor (QStringView name) const
ActionList	actions () const
QString	ns () const
bool	operator== (const char *className)
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)
virtual bool	postFork (Application *app)
virtual bool	preFork (Application *app)
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

Controllers are where the actions in the Cutelyst framework reside. Each action is represented by a function with an attribute to identify what kind of action it is. See the Cutelyst::Dispatcher for more info about how Cutelyst dispatches to actions.

Use C_ATTR to give hints about methods build like methodName_option Where option is one of the following:

:Path - An ending path relative to the class info Namespace for example:
:Path("") - /namespace/controlername (used for the index)
:Path("foo") - /namespace/controlername/foo
:Path("/bar") - /namespace/bar

:Chained - Sets the name of this part of the chain. If it is specified without arguments, it takes the name of the action as default.

:PathPart - The part of the chained path

:Args - In the case of more than 9 parameters, to build the path set the needed number here, where an empty string means unlimited arguments.

:CaptureArgs - In the case of more than 9 parameters, to be captured the path set the needed number here, where -1 means unlimited arguments.

:Global - Alias to Path="/methodname" which sets the method relative to your root.

:Local - Alias to Path="methodname".

:Args - When used with "Path" it indicates the number of arguments in the path.
The number is computed by counting the arguments the method expects.
However if no Args value is set, assumed to 'slurp' all remaining path parts under this namespace.

There are also three special methods that can be implemented that will be automatically dispatched, they are Begin(), Auto() and End().

Begin(Context*) and End(Context*) are both called on the closest namespace match. If the Controller implements Begin it's that action that will be called otherwise it will try to match looking at the namespace.

Auto(Context*) is called in namespace order, so if you have a Foo and a FooBar controller with 'foo' and 'foo/bar' namespaces respectively and both implement Auto(), you get Foo->Auto() and FooBar->Auto() called.

Definition at line 87 of file controller.h.

Constructor & Destructor Documentation

Controller()

Controller::Controller ( QObject * parent = nullptr )

explicit

Constructs a Controller object with the given parent.

Definition at line 17 of file controller.cpp.

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

Referenced by _DISPATCH(), actionFor(), actionFor(), actions(), and ns().

~Controller()

Controller::~Controller ( )

virtual

Definition at line 23 of file controller.cpp.

Member Function Documentation

_DISPATCH()

bool Controller::_DISPATCH ( Context * c )

protected

This is called by the dispatch engine to do the contextual action dispatching. Transversing each namespace's Begin(), nearest Auto(), the Action method of this controller and nearest End().

Definition at line 162 of file controller.cpp.

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

Referenced by Cutelyst::Dispatcher::dispatch().

actionFor() [1/2]

Action * Controller::actionFor

(

const QString &

name

)

const

Returns the Cutelyst::Action object (if any) for a given method name in this class namespace.

You can also use the macro CActionFor to keep the resolved action around.

Definition at line 36 of file controller.cpp.

References Controller().

Referenced by Cutelyst::RoleACL::dispatcherReady().

actionFor() [2/2]

Action * Controller::actionFor

(

QStringView

name

)

const

Returns the Cutelyst::Action object (if any) for a given method name in this class namespace.

You can also use the macro CActionFor to keep the resolved action around.

Definition at line 46 of file controller.cpp.

References Controller(), and QStringView::toString().

actions()

ActionList Controller::actions

(

)

const

Returns the Cutelyst::ActionList containing all actions which belongs to this controller.

Definition at line 56 of file controller.cpp.

References Controller().

ns()

QString Controller::ns

(

)

const

This specifies the internal namespace the controller should be bound to. By default the controller is bound to the URI version of the controller name. For instance a controller named 'MyFooBar' will be bound to 'my/foo/bar'. The default Root controller is an example of setting namespace to '' (the null string).

Definition at line 30 of file controller.cpp.

References Controller().

operator==()

bool Controller::operator==

(

const char *

className

)

Return TRUE if className is equal to this Controller's name

Definition at line 62 of file controller.cpp.

References QObject::metaObject().

postFork()

bool Controller::postFork ( Application * app )

protectedvirtual

This method is called after the application has registered all controllers.

Reimplement this method if you need to configure internal variable and you need to know for example which configuration options are enabled.

Definition at line 73 of file controller.cpp.

preFork()

bool Controller::preFork ( Application * app )

protectedvirtual

This method is called right after Controller has been setup and before application forks and

See also

postFork() is called.

Reimplement this method if you need to configure internal variable and you need to know for example which configuration options are enabled.

Definition at line 67 of file controller.cpp.

Friends And Related Symbol Documentation

Application

friend class Application

friend

Definition at line 167 of file controller.h.

Dispatcher

friend class Dispatcher

friend

Definition at line 168 of file controller.h.