express::dispatcher::RouterDispatcher Class Reference

#include <RouterDispatcher.h>

Inheritance diagram for express::dispatcher::RouterDispatcher:

Collaboration diagram for express::dispatcher::RouterDispatcher:

Public Member Functions
std::list< express::Route > &	getRoutes ()
std::list< std::string >	getRoutes (const std::string &parentMountPath, const MountPoint &mountPoint) const
bool	setStrictRouting (bool strictRouting)
bool	getStrictRouting () 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, const std::string &parentMountPath)

Private Member Functions
bool	dispatch (express::Controller &controller, const std::string &parentMountPath, const express::MountPoint &mountPoint) 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

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

Detailed Description

Definition at line 60 of file RouterDispatcher.h.

Member Function Documentation

dispatch()

bool express::dispatcher::RouterDispatcher::dispatch ( express::Controller &  controller, const std::string &  parentMountPath, const express::MountPoint &  mountPoint  )

overrideprivatevirtual

Implements express::Dispatcher.

Definition at line 76 of file RouterDispatcher.cpp.

                                                                                                                                   {
        bool dispatched = false;
 
        const std::string absoluteMountPath = parentMountPath + mountPoint.relativeMountPath;
 
        const std::string requestMethod = controller.getRequest()->method;
        const std::string requestUrl = controller.getRequest()->url;
        const std::string requestPath = controller.getRequest()->path;
 
        // clang-format off
        const bool requestMatched =
            (
                (
                    (
                        mountPoint.method == controller.getRequest()->method
                    ) || (
                        mountPoint.method == "all"
                    ) || (
                        mountPoint.method == "use"
                    )
                ) && (
                    (
                        requestUrl.starts_with(absoluteMountPath)
                    )
                )
            );
        // clang-format on
        LOG(TRACE) << controller.getResponse()->getSocketContext()->getSocketConnection()->getConnectionName()
                   << " HTTP Express: router -> " << (requestMatched ? "MATCH" : "NO MATCH");
        LOG(TRACE) << "      RequestMethod: " << controller.getRequest()->method;
        LOG(TRACE) << "         RequestUrl: " << controller.getRequest()->url;
        LOG(TRACE) << "        RequestPath: " << controller.getRequest()->path;
        LOG(TRACE) << "  AbsoluteMountPath: " << absoluteMountPath;
        LOG(TRACE) << "      StrictRouting: " << controller.getStrictRouting();
        LOG(TRACE) << "      StrictRouting: " << controller.getStrictRouting();
 
        if (requestMatched) {
            for (Route& route : routes) {
                const bool oldStrictRouting = controller.setStrictRouting(strictRouting);
 
                dispatched = route.dispatch(controller, absoluteMountPath);
 
                controller.setStrictRouting(oldStrictRouting);
 
                if (dispatched) {
                    LOG(TRACE) << "Express: R - Dispatched: " << dispatched;
                }
                if (controller.nextRouterCalled()) {
                    LOG(TRACE) << "Express: R - NextRouter called - breaking dispatching";
                }
                if (dispatched || controller.nextRouterCalled()) {
                    break;
                }
            }
        }
 
        return dispatched;
    }

References express::Route::dispatch(), core::socket::stream::SocketConnection::getConnectionName(), express::Controller::getRequest(), express::Controller::getResponse(), core::socket::stream::SocketContext::getSocketConnection(), express::Response::getSocketContext(), express::Controller::getStrictRouting(), express::MountPoint::method, express::Request::method, express::Controller::nextRouterCalled(), express::Request::path, express::MountPoint::relativeMountPath, routes, express::Controller::setStrictRouting(), strictRouting, and express::Request::url.

Here is the call graph for this function:

getRoutes() [1/3]

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

(

)

Definition at line 59 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 135 of file RouterDispatcher.cpp.

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

References getRoutes(), and strictRouting.

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 140 of file RouterDispatcher.cpp.

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

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

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

                                                  {
        return strictRouting;
    }

References strictRouting.

Referenced by express::RootRoute::dispatch(), and express::RootRoute::setStrictRouting().

Here is the caller graph for this function:

setStrictRouting()

bool express::dispatcher::RouterDispatcher::setStrictRouting

(

bool

strictRouting

)

Definition at line 63 of file RouterDispatcher.cpp.

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

References strictRouting.

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

Here is the caller graph for this function:

Member Data Documentation

routes

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

private

Definition at line 75 of file RouterDispatcher.h.

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

strictRouting

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

private

Definition at line 77 of file RouterDispatcher.h.

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

---

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

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