Cutelyst  2.13.0
Public Member Functions | Protected Member Functions | Friends | List of all members
Cutelyst::Controller Class Reference

Cutelyst Controller base class More...

#include <Cutelyst/Controller>

Inheritance diagram for Cutelyst::Controller:
Inheritance graph

Public Member Functions

 Controller (QObject *parent=nullptr)
ActionactionFor (const QString &name) const
ActionList actions () const
QString ns () const
bool operator== (const char *className)

Protected Member Functions

bool _DISPATCH (Context *c)
virtual bool postFork (Application *app)
virtual bool preFork (Application *app)


class Application
class Dispatcher

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 102 of file controller.h.

Constructor & Destructor Documentation

◆ Controller()

Controller::Controller ( QObject *  parent = nullptr)

Constructs a Controller object with the given parent.

Definition at line 32 of file controller.cpp.

Member Function Documentation


bool Controller::_DISPATCH ( Context c)

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 164 of file controller.cpp.

References Cutelyst::Context::attachAsync().

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

◆ actionFor()

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 50 of file controller.cpp.

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

◆ actions()

ActionList Controller::actions ( ) const

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

Definition at line 60 of file controller.cpp.

◆ 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 44 of file controller.cpp.

◆ operator==()

bool Controller::operator== ( const char *  className)

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

Definition at line 66 of file controller.cpp.

◆ postFork()

bool Controller::postFork ( Application app)

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 77 of file controller.cpp.

◆ preFork()

bool Controller::preFork ( Application app)

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 71 of file controller.cpp.