Cutelyst::DispatchTypePath Class Reference

Inheritance diagram for Cutelyst::DispatchTypePath:

Public Member Functions
	DispatchTypePath (QObject *parent=nullptr)
virtual bool	inUse () override
virtual QByteArray	list () const override
	list the registered actions To be implemented by subclasses
virtual MatchType	match (Context *c, const QString &path, const QStringList &args) const override
virtual bool	registerAction (Action *action) override
	registerAction
virtual QString	uriForAction (Action *action, const QStringList &captures) const override
Public Member Functions inherited from Cutelyst::DispatchType
	DispatchType (QObject *parent=nullptr)
virtual Action *	expandAction (const Context *c, Action *action) const
virtual bool	inUse ()=0
virtual bool	isLowPrecedence () const
virtual QByteArray	list () const =0
	list the registered actions To be implemented by subclasses
virtual MatchType	match (Context *c, const QString &path, const QStringList &args) const =0
virtual bool	registerAction (Action *action)
	registerAction
virtual QString	uriForAction (Action *action, const QStringList &captures) const =0

Additional Inherited Members
Public Types inherited from Cutelyst::DispatchType
enum	MatchType { NoMatch , PartialMatch , ExactMatch }
Protected Member Functions inherited from Cutelyst::DispatchType
void	setupMatchedAction (Context *c, Action *action) const

Detailed Description

Definition at line 15 of file dispatchtypepath.h.

Constructor & Destructor Documentation

DispatchTypePath()

DispatchTypePath::DispatchTypePath ( QObject *  parent = nullptr )

explicit

Constructs a DispatchTypePath object with the given parent.

Definition at line 16 of file dispatchtypepath.cpp.

~DispatchTypePath()

DispatchTypePath::~DispatchTypePath ( )

overridevirtual

Definition at line 22 of file dispatchtypepath.cpp.

Member Function Documentation

inUse()

bool DispatchTypePath::inUse ( )

overridevirtual

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.

Implements Cutelyst::DispatchType.

Definition at line 121 of file dispatchtypepath.cpp.

list()

QByteArray DispatchTypePath::list ( ) const

overridevirtual

Implements Cutelyst::DispatchType.

Definition at line 27 of file dispatchtypepath.cpp.

match()

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

overridevirtual

Return true if the dispatchType matches the given path

Implements Cutelyst::DispatchType.

Definition at line 65 of file dispatchtypepath.cpp.

References Cutelyst::Request::setArguments(), Cutelyst::Request::setMatch(), and Cutelyst::DispatchType::setupMatchedAction().

registerAction()

bool DispatchTypePath::registerAction ( Action *  action )

overridevirtual

Parameters

action

Returns

Reimplemented from Cutelyst::DispatchType.

Definition at line 104 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes().

uriForAction()

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

overridevirtual

Get a URI part for an action Always returns NULL if captures is not empty since Path actions don't have captures

Implements Cutelyst::DispatchType.

Definition at line 127 of file dispatchtypepath.cpp.

References Cutelyst::Action::attributes().