express::dispatcher::RouterDispatcher Class Reference

#include <RouterDispatcher.h>

Inheritance diagram for express::dispatcher::RouterDispatcher:

Collaboration diagram for express::dispatcher::RouterDispatcher:

Public Member Functions
RouterDispatcher &	setStrictRouting (bool strictRouting)
bool	getStrictRouting () const
RouterDispatcher &	setCaseInsensitiveRouting (bool caseInsensitiveRouting)
bool	getCaseInsensitiveRouting () const
RouterDispatcher &	setMergeParams (bool mergeParams)
bool	getMergeParams () const
std::list< express::Route > &	getRoutes ()
std::list< std::string >	getRoutes (const std::string &parentMountPath, const MountPoint &mountPoint) const
Public Member Functions inherited from express::Dispatcher
	Dispatcher (const Dispatcher &)=delete
Dispatcher &	operator= (const Dispatcher &)=delete
	Dispatcher ()=default
virtual	~Dispatcher ()
bool	dispatchNext (Controller &controller, bool strictRouting, bool caseInsensitiveRouting, bool mergeParams)

Private Member Functions
bool	dispatch (express::Controller &controller, const express::MountPoint &mountPoint, bool strictRoutingUnused, bool caseInsensitiveRoutingUnused, bool mergeParamsUnused) override
std::list< std::string >	getRoutes (const std::string &parentMountPath, const MountPoint &mountPoint, bool strictRouting) const override

Private Attributes
std::list< express::Route >	routes
bool	strictRouting = false
bool	caseInsensitiveRouting = true
bool	mergeParams = false
std::regex	regex
std::vector< std::string >	names

Additional Inherited Members
Protected Attributes inherited from express::Dispatcher
std::shared_ptr< Route >	nextRoute = nullptr

Detailed Description

Definition at line 62 of file RouterDispatcher.h.

Member Function Documentation

dispatch()

bool express::dispatcher::RouterDispatcher::dispatch ( express::Controller & controller, const express::MountPoint & mountPoint, bool strictRoutingUnused, bool caseInsensitiveRoutingUnused, bool mergeParamsUnused )

overrideprivatevirtual

Implements express::Dispatcher.

Definition at line 67 of file RouterDispatcher.cpp.

                                                                             {
        LOG(TRACE) << "======================= ROUTER      DISPATCH =======================";
        LOG(TRACE) << controller.getResponse()->getSocketContext()->getSocketConnection()->getConnectionName();
        LOG(TRACE) << "          Request Method: " << controller.getRequest()->method;
        LOG(TRACE) << "             Request Url: " << controller.getRequest()->url;
        LOG(TRACE) << "            Request Path: " << controller.getRequest()->path;
        LOG(TRACE) << "       Mountpoint Method: " << mountPoint.method;
        LOG(TRACE) << "         Mountpoint Path: " << mountPoint.relativeMountPath;
        LOG(TRACE) << "           StrictRouting: " << this->strictRouting;
        LOG(TRACE) << "  CaseInsensitiveRouting: " << this->caseInsensitiveRouting;
        LOG(TRACE) << "             MergeParams: " << this->mergeParams;
 
        bool dispatched = false;
 
        const bool methodMatchesResult = methodMatches(controller.getRequest()->method, mountPoint.method);
 
        if (methodMatchesResult && (controller.getFlags() & Controller::NEXT) == 0) {
            const MountMatchResult match = matchMountPoint(
                controller, mountPoint.relativeMountPath, mountPoint, regex, names, this->strictRouting, this->caseInsensitiveRouting);
 
            if (match.requestMatched) {
                LOG(TRACE) << "----------------------- ROUTER         MATCH -----------------------";
 
                dispatched = true;
 
                if (!match.decodeError) {
                    express::Request& request = *controller.getRequest();
                    request.queries.insert(match.requestQueryPairs.begin(), match.requestQueryPairs.end());
 
                    // Express-style mount path stripping is only applied for use()
                    const ScopedPathStrip pathStrip(request, match.isPrefix, match.consumedLength);
                    const ScopedParams scopedParams(request, match.params, this->mergeParams);
 
                    for (Route& route : routes) {
                        dispatched = route.dispatch(controller, this->strictRouting, this->caseInsensitiveRouting, this->mergeParams);
 
                        if (dispatched || controller.nextRouterCalled()) {
                            break;
                        }
                    }
                } else {
                    controller.getResponse()->sendStatus(400);
                }
            } else {
                LOG(TRACE) << "----------------------- ROUTER       NOMATCH -----------------------";
            }
        } else {
            LOG(TRACE) << "----------------------- ROUTER       NOMATCH -----------------------";
        }
 
        return dispatched;
    }

References caseInsensitiveRouting, express::dispatcher::MountMatchResult::consumedLength, express::dispatcher::MountMatchResult::decodeError, express::Route::dispatch(), core::socket::stream::SocketConnection::getConnectionName(), express::Controller::getFlags(), express::Controller::getRequest(), express::Controller::getResponse(), core::socket::stream::SocketContext::getSocketConnection(), express::Response::getSocketContext(), express::dispatcher::MountMatchResult::isPrefix, logger::LogMessage::LogMessage(), express::dispatcher::matchMountPoint(), mergeParams, express::MountPoint::method, express::Request::method, express::dispatcher::methodMatches(), names, express::Controller::NEXT, express::Controller::nextRouterCalled(), express::dispatcher::MountMatchResult::params, express::Request::path, express::Request::queries, express::MountPoint::relativeMountPath, express::dispatcher::MountMatchResult::requestMatched, express::dispatcher::MountMatchResult::requestQueryPairs, routes, express::dispatcher::ScopedParams::ScopedParams(), express::dispatcher::ScopedPathStrip::ScopedPathStrip(), express::Response::sendStatus(), strictRouting, logger::TRACE, and express::Request::url.

Here is the call graph for this function:

getCaseInsensitiveRouting()

bool express::dispatcher::RouterDispatcher::getCaseInsensitiveRouting

(

)

const

Definition at line 156 of file RouterDispatcher.cpp.

                                                           {
        return caseInsensitiveRouting;
    }

References caseInsensitiveRouting.

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

Here is the caller graph for this function:

getMergeParams()

bool express::dispatcher::RouterDispatcher::getMergeParams

(

)

const

Definition at line 166 of file RouterDispatcher.cpp.

                                                {
        return mergeParams;
    }

References mergeParams.

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

Here is the caller graph for this function:

getRoutes() [1/3]

std::list< Route > & express::dispatcher::RouterDispatcher::getRoutes

(

)

Definition at line 63 of file RouterDispatcher.cpp.

                                                {
        return routes;
    }

References routes.

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

Here is the caller graph for this function:

getRoutes() [2/3]

std::list< std::string > express::dispatcher::RouterDispatcher::getRoutes	(	const std::string &	parentMountPath,
		const MountPoint &	mountPoint ) const

Definition at line 124 of file RouterDispatcher.cpp.

                                                                                                                       {
        return getRoutes(parentMountPath, mountPoint, false);
    }

References getRoutes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRoutes() [3/3]

std::list< std::string > express::dispatcher::RouterDispatcher::getRoutes ( const std::string & parentMountPath, const MountPoint & mountPoint, bool strictRouting ) const

overrideprivatevirtual

Implements express::Dispatcher.

Definition at line 129 of file RouterDispatcher.cpp.

                                                                                                                        {
        std::list<std::string> collectedRoutes;
 
        for (const Route& route : routes) {
            collectedRoutes.splice(collectedRoutes.end(),
                                   route.getRoute(parentMountPath + "$" + mountPoint.relativeMountPath + "$", strictRouting));
        }
 
        return collectedRoutes;
    }

References express::Route::getRoute(), express::MountPoint::relativeMountPath, and routes.

Referenced by getRoutes().

Here is the call graph for this function:

Here is the caller graph for this function:

getStrictRouting()

bool express::dispatcher::RouterDispatcher::getStrictRouting

(

)

const

Definition at line 146 of file RouterDispatcher.cpp.

                                                  {
        return strictRouting;
    }

References strictRouting.

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

Here is the caller graph for this function:

setCaseInsensitiveRouting()

RouterDispatcher & express::dispatcher::RouterDispatcher::setCaseInsensitiveRouting

(

bool

caseInsensitiveRouting

)

Definition at line 150 of file RouterDispatcher.cpp.

                                                                                             {
        this->caseInsensitiveRouting = caseInsensitiveRouting;
 
        return *this;
    }

References caseInsensitiveRouting.

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

Here is the caller graph for this function:

setMergeParams()

RouterDispatcher & express::dispatcher::RouterDispatcher::setMergeParams

(

bool

mergeParams

)

Definition at line 160 of file RouterDispatcher.cpp.

                                                                       {
        this->mergeParams = mergeParams;
 
        return *this;
    }

References mergeParams.

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

Here is the caller graph for this function:

setStrictRouting()

RouterDispatcher & express::dispatcher::RouterDispatcher::setStrictRouting

(

bool

strictRouting

)

Definition at line 140 of file RouterDispatcher.cpp.

                                                                           {
        this->strictRouting = strictRouting;
 
        return *this;
    }

References strictRouting.

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

Here is the caller graph for this function:

Member Data Documentation

caseInsensitiveRouting

bool express::dispatcher::RouterDispatcher::caseInsensitiveRouting = true

private

Definition at line 90 of file RouterDispatcher.h.

Referenced by dispatch(), getCaseInsensitiveRouting(), and setCaseInsensitiveRouting().

mergeParams

bool express::dispatcher::RouterDispatcher::mergeParams = false

private

Definition at line 91 of file RouterDispatcher.h.

Referenced by dispatch(), getMergeParams(), and setMergeParams().

names

std::vector<std::string> express::dispatcher::RouterDispatcher::names

private

Definition at line 94 of file RouterDispatcher.h.

Referenced by dispatch().

regex

std::regex express::dispatcher::RouterDispatcher::regex

private

Definition at line 93 of file RouterDispatcher.h.

routes

std::list<express::Route> express::dispatcher::RouterDispatcher::routes

private

Definition at line 87 of file RouterDispatcher.h.

Referenced by dispatch(), getRoutes(), and getRoutes().

strictRouting

bool express::dispatcher::RouterDispatcher::strictRouting = false

private

Definition at line 89 of file RouterDispatcher.h.

Referenced by dispatch(), getStrictRouting(), and setStrictRouting().

---

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

• express/dispatcher/RouterDispatcher.h
• express/dispatcher/RouterDispatcher.cpp