express::Controller Class Reference

#include <Controller.h>

Collaboration diagram for express::Controller:

Public Types
enum	Flags { NONE = 0 , NEXT = 1 << 0 , NEXT_ROUTE = 1 << 1 , NEXT_ROUTER = 1 << 2 }

Public Member Functions
	Controller (const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
	Controller (const Controller &controller)
Controller &	operator= (const Controller &controller) noexcept
void	setRootRoute (RootRoute *rootRoute)
void	setCurrentRoute (Route *currentRoute)
const std::shared_ptr< Request > &	getRequest ()
const std::shared_ptr< Response > &	getResponse ()
int	getFlags () const
void	next (const std::string &how) const
bool	nextRouterCalled ()
bool	dispatchNext (const std::string &parentMountPath)
bool	setStrictRouting (bool strictRouting)
bool	getStrictRouting () const

Private Attributes
std::shared_ptr< Request >	request
std::shared_ptr< Response >	response
RootRoute *	rootRoute = nullptr
Route *	lastRoute = nullptr
Route *	currentRoute = nullptr
bool	strictRouting
unsigned long	lastTick = 0
int	flags = NONE

Detailed Description

Definition at line 66 of file Controller.h.

Member Enumeration Documentation

Flags

enum express::Controller::Flags

Enumerator
NONE
NEXT
NEXT_ROUTE
NEXT_ROUTER

Definition at line 90 of file Controller.h.

{ NONE = 0, NEXT = 1 << 0, NEXT_ROUTE = 1 << 1, NEXT_ROUTER = 1 << 2 };

Constructor & Destructor Documentation

Controller() [1/2]

express::Controller::Controller	(	const std::shared_ptr< web::http::server::Request > &	request,
		const std::shared_ptr< web::http::server::Response > &	response
	)

Definition at line 55 of file Controller.cpp.

        : request(std::make_shared<Request>(request))
        , response(std::make_shared<Response>(response))
        , lastTick(core::EventLoop::getTickCounter()) {
    }

References core::EventLoop::getTickCounter(), lastTick, request, and response.

Referenced by express::WebAppT< ServerT >::WebAppT().

Here is the call graph for this function:

Here is the caller graph for this function:

Controller() [2/2]

express::Controller::Controller

(

const Controller &

controller

)

Definition at line 62 of file Controller.cpp.

        : request(controller.request)
        , response(controller.response)
        , rootRoute(controller.rootRoute)
        , lastRoute(controller.lastRoute)
        , currentRoute(controller.currentRoute)
        , lastTick(controller.lastTick)
        , flags(controller.flags) {
    }

References currentRoute, flags, lastRoute, lastTick, request, response, and rootRoute.

Referenced by express::Next::Next().

Here is the caller graph for this function:

Member Function Documentation

dispatchNext()

bool express::Controller::dispatchNext

(

const std::string &

parentMountPath

)

Definition at line 132 of file Controller.cpp.

                                                                  {
        bool dispatched = false;
 
        if (((flags & Controller::NEXT) != 0)) {
            if (lastRoute == currentRoute) {
                flags &= ~Controller::NEXT;
                if ((flags & Controller::NEXT_ROUTE) != 0) {
                    flags &= ~Controller::NEXT_ROUTE;
                } else if ((flags & Controller::NEXT_ROUTER) == 0) {
                    dispatched = currentRoute->dispatchNext(*this, parentMountPath);
                }
            } else { // ? Optimization: Dispatch only parent route matched path
                dispatched = currentRoute->dispatchNext(*this, parentMountPath);
            }
        }
 
        return dispatched;
    }

References currentRoute, express::Route::dispatchNext(), flags, lastRoute, NEXT, NEXT_ROUTE, and NEXT_ROUTER.

Referenced by express::Route::dispatch().

Here is the call graph for this function:

Here is the caller graph for this function:

getFlags()

int express::Controller::getFlags

(

)

const

Definition at line 102 of file Controller.cpp.

                                   {
        return flags;
    }

References flags.

Referenced by express::dispatcher::ApplicationDispatcher::dispatch(), and express::dispatcher::MiddlewareDispatcher::dispatch().

Here is the caller graph for this function:

getRequest()

const std::shared_ptr< Request > & express::Controller::getRequest

(

)

Definition at line 94 of file Controller.cpp.

                                                         {
        return request;
    }

References request.

Referenced by express::dispatcher::ApplicationDispatcher::dispatch(), express::dispatcher::MiddlewareDispatcher::dispatch(), and express::dispatcher::RouterDispatcher::dispatch().

Here is the caller graph for this function:

getResponse()

const std::shared_ptr< Response > & express::Controller::getResponse

(

)

Definition at line 98 of file Controller.cpp.

                                                           {
        return response;
    }

References response.

Referenced by express::RootRoute::dispatch(), express::dispatcher::ApplicationDispatcher::dispatch(), and express::dispatcher::MiddlewareDispatcher::dispatch().

Here is the caller graph for this function:

getStrictRouting()

bool express::Controller::getStrictRouting

(

)

const

Definition at line 159 of file Controller.cpp.

                                            {
        return strictRouting;
    }

References strictRouting.

Referenced by express::Route::dispatch(), express::dispatcher::ApplicationDispatcher::dispatch(), express::dispatcher::MiddlewareDispatcher::dispatch(), and express::dispatcher::RouterDispatcher::dispatch().

Here is the caller graph for this function:

next()

void express::Controller::next

(

const std::string &

how

)

const

Definition at line 106 of file Controller.cpp.

                                                    {
        flags = NEXT;
 
        if (how == "route") {
            flags |= NEXT_ROUTE;
        } else if (how == "router") {
            flags |= NEXT_ROUTER;
        }
 
        lastRoute = currentRoute;
 
        if (lastTick != core::EventLoop::getTickCounter()) { // If asynchronous next() start traversing of route-tree
            rootRoute->dispatch(*const_cast<express::Controller*>(this));
        }
    }

References currentRoute, express::RootRoute::dispatch(), flags, core::EventLoop::getTickCounter(), lastRoute, lastTick, NEXT, NEXT_ROUTE, NEXT_ROUTER, and rootRoute.

Referenced by express::Next::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

nextRouterCalled()

bool express::Controller::nextRouterCalled

(

)

Definition at line 122 of file Controller.cpp.

                                      {
        const bool breakDispatching = lastRoute == currentRoute && (flags & Controller::NEXT_ROUTER) != 0;
 
        if (breakDispatching) {
            flags &= ~Controller::NEXT_ROUTER;
        }
 
        return breakDispatching;
    }

References currentRoute, flags, lastRoute, and NEXT_ROUTER.

Referenced by express::dispatcher::RouterDispatcher::dispatch().

Here is the caller graph for this function:

operator=()

Controller & express::Controller::operator= ( const Controller &  controller )

noexcept

Definition at line 72 of file Controller.cpp.

                                                                           {
        if (this != &controller) {
            request = controller.request;
            response = controller.response;
            rootRoute = controller.rootRoute;
            lastRoute = controller.lastRoute;
            currentRoute = controller.currentRoute;
            lastTick = controller.lastTick;
            flags = controller.flags;
        }
 
        return *this;
    }

References currentRoute, flags, lastRoute, lastTick, request, response, and rootRoute.

Referenced by express::dispatcher::MiddlewareDispatcher::dispatch().

Here is the caller graph for this function:

setCurrentRoute()

void express::Controller::setCurrentRoute

(

Route *

currentRoute

)

Definition at line 90 of file Controller.cpp.

                                                        {
        this->currentRoute = currentRoute;
    }

References currentRoute.

Referenced by express::Route::dispatch().

Here is the caller graph for this function:

setRootRoute()

void express::Controller::setRootRoute

(

RootRoute *

rootRoute

)

Definition at line 86 of file Controller.cpp.

                                                      {
        this->rootRoute = rootRoute;
    }

References rootRoute.

Referenced by express::RootRoute::dispatch().

Here is the caller graph for this function:

setStrictRouting()

bool express::Controller::setStrictRouting

(

bool

strictRouting

)

Definition at line 151 of file Controller.cpp.

                                                        {
        const bool oldStrictRouting = this->strictRouting;
 
        this->strictRouting = strictRouting;
 
        return oldStrictRouting;
    }

References strictRouting.

Referenced by express::RootRoute::dispatch(), express::Route::dispatch(), and express::dispatcher::RouterDispatcher::dispatch().

Here is the caller graph for this function:

Member Data Documentation

currentRoute

Route* express::Controller::currentRoute = nullptr

private

Definition at line 99 of file Controller.h.

Referenced by Controller(), dispatchNext(), next(), nextRouterCalled(), operator=(), and setCurrentRoute().

flags

int express::Controller::flags = NONE

mutableprivate

Definition at line 105 of file Controller.h.

Referenced by Controller(), dispatchNext(), getFlags(), next(), nextRouterCalled(), and operator=().

lastRoute

Route* express::Controller::lastRoute = nullptr

mutableprivate

Definition at line 98 of file Controller.h.

Referenced by Controller(), dispatchNext(), next(), nextRouterCalled(), and operator=().

lastTick

unsigned long express::Controller::lastTick = 0

private

Definition at line 103 of file Controller.h.

Referenced by Controller(), Controller(), next(), and operator=().

request

std::shared_ptr<Request> express::Controller::request

private

Definition at line 93 of file Controller.h.

Referenced by Controller(), Controller(), getRequest(), and operator=().

response

std::shared_ptr<Response> express::Controller::response

private

Definition at line 94 of file Controller.h.

Referenced by Controller(), Controller(), getResponse(), and operator=().

rootRoute

RootRoute* express::Controller::rootRoute = nullptr

private

Definition at line 96 of file Controller.h.

Referenced by Controller(), next(), operator=(), and setRootRoute().

strictRouting

bool express::Controller::strictRouting

private

Definition at line 101 of file Controller.h.

Referenced by getStrictRouting(), and setStrictRouting().

---

The documentation for this class was generated from the following files:

• express/Controller.h
• express/Controller.cpp