#include <SocketContextUpgradeFactorySelector.h>

Collaboration diagram for web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >:

Classes
struct	SocketContextPlugin

Public Types
using	SocketContextUpgradeFactory = SocketContextUpgradeFactoryT

using	Request = typename SocketContextUpgradeFactory::Request

using	Response = typename SocketContextUpgradeFactory::Response

Public Member Functions
virtual SocketContextUpgradeFactory *	select (Request &req, Response &res)=0

bool	add (SocketContextUpgradeFactory *socketContextUpgradeFactory)

void	link (const std::string &socketContextUpgradeName, SocketContextUpgradeFactory (linkedPlugin)())

void	allowDlOpen ()

void	unload (SocketContextUpgradeFactory *socketContextUpgradeFactory)

Protected Member Functions
	SocketContextUpgradeFactorySelector ()=default

virtual	~SocketContextUpgradeFactorySelector ()=default

SocketContextUpgradeFactory *	select (const std::string &socketContextUpgradeName)

virtual SocketContextUpgradeFactory *	load (const std::string &socketContextUpgradeName)=0

SocketContextUpgradeFactory *	load (const std::string &socketContextUpgradeName, const std::string &socketContextUpgradeFactoryLibraryFile, const std::string &socketContextUpgradeFactoryFunctionName)

bool	add (SocketContextUpgradeFactory socketContextUpgradeFactory, void handler)

Private Attributes
std::map< std::string, SocketContextPlugin >	socketContextUpgradePlugins

std::map< std::string, SocketContextUpgradeFactory ()()>	linkedSocketContextUpgradePlugins

bool	onlyLinked = false

Detailed Description

template<typename SocketContextUpgradeFactoryT>
class web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >

Definition at line 35 of file SocketContextUpgradeFactorySelector.h.

Member Typedef Documentation

◆ Request

template<typename SocketContextUpgradeFactoryT >

using web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::Request = typename SocketContextUpgradeFactory::Request

Definition at line 38 of file SocketContextUpgradeFactorySelector.h.

◆ Response

template<typename SocketContextUpgradeFactoryT >

using web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::Response = typename SocketContextUpgradeFactory::Response

Definition at line 39 of file SocketContextUpgradeFactorySelector.h.

◆ SocketContextUpgradeFactory

template<typename SocketContextUpgradeFactoryT >

using web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::SocketContextUpgradeFactory = SocketContextUpgradeFactoryT

Definition at line 37 of file SocketContextUpgradeFactorySelector.h.

Constructor & Destructor Documentation

◆ SocketContextUpgradeFactorySelector()

template<typename SocketContextUpgradeFactoryT >

web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::SocketContextUpgradeFactorySelector ( )

protecteddefault

◆ ~SocketContextUpgradeFactorySelector()

template<typename SocketContextUpgradeFactoryT >

virtual web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::~SocketContextUpgradeFactorySelector ( )

protectedvirtualdefault

Member Function Documentation

◆ add() [1/2]

template<typename SocketContextUpgradeFactory >

bool web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::add ( SocketContextUpgradeFactory * socketContextUpgradeFactory )

Definition at line 51 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                                                                       {
        return add(socketContextUpgradeFactory, nullptr);
    }

◆ add() [2/2]

template<typename SocketContextUpgradeFactory >

bool web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::add	(	SocketContextUpgradeFactory *	socketContextUpgradeFactory,
		void *	handler )

protected

Definition at line 38 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                             {
        bool success = false;
 
        if (socketContextUpgradeFactory != nullptr) {
            SocketContextPlugin socketContextPlugin = {.socketContextUpgradeFactory = socketContextUpgradeFactory, .handle = handle};
            std::tie(std::ignore, success) = socketContextUpgradePlugins.insert({socketContextUpgradeFactory->name(), socketContextPlugin});
        }
 
        return success;
    }

◆ allowDlOpen()

template<typename SocketContextUpgradeFactory >

void web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::allowDlOpen ( )

Definition at line 56 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                       {
        onlyLinked = false;
    }

◆ link()

template<typename SocketContextUpgradeFactory >

void web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::link	(	const std::string &	socketContextUpgradeName,
		SocketContextUpgradeFactory (	linkedPlugin )() )

Definition at line 117 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                                                                {
        if (!linkedSocketContextUpgradePlugins.contains(socketContextUpgradeName)) {
            linkedSocketContextUpgradePlugins[socketContextUpgradeName] = linkedPlugin;
        }
 
        onlyLinked = true;
    }

◆ load() [1/2]

template<typename SocketContextUpgradeFactoryT >

virtual SocketContextUpgradeFactory * web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::load ( const std::string & socketContextUpgradeName )

protectedpure virtual

Implemented in web::http::client::SocketContextUpgradeFactorySelector, and web::http::server::SocketContextUpgradeFactorySelector.

◆ load() [2/2]

template<typename SocketContextUpgradeFactory >

SocketContextUpgradeFactory * web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::load	(	const std::string &	socketContextUpgradeName,
		const std::string &	socketContextUpgradeFactoryLibraryFile,
		const std::string &	socketContextUpgradeFactoryFunctionName )

protected

Definition at line 62 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                                                                     {
        SocketContextUpgradeFactory* socketContextUpgradeFactory = nullptr;
 
        void* handle = core::DynamicLoader::dlOpen(socketContextUpgradeFactoryLibraryFile);
 
        if (handle != nullptr) {
            SocketContextUpgradeFactory* (*getSocketContextUpgradeFactory)() = reinterpret_cast<SocketContextUpgradeFactory* (*) ()>(
                core::DynamicLoader::dlSym(handle, socketContextUpgradeFactoryFunctionName));
 
            if (getSocketContextUpgradeFactory != nullptr) {
                socketContextUpgradeFactory = getSocketContextUpgradeFactory();
 
                if (socketContextUpgradeFactory != nullptr) {
                    if (add(socketContextUpgradeFactory, handle)) {
                        LOG(DEBUG) << "HTTP: SocketContextUpgradeFactory created successful: " << socketContextUpgradeName;
                    } else {
                        LOG(DEBUG) << "HTTP: UpgradeSocketContext already existing. Not using: " << socketContextUpgradeName;
                        delete socketContextUpgradeFactory;
                        socketContextUpgradeFactory = nullptr;
                        core::DynamicLoader::dlClose(handle);
                    }
                } else {
                    LOG(ERROR) << "HTTP: SocketContextUpgradeFactory not created: " << socketContextUpgradeName;
                    core::DynamicLoader::dlClose(handle);
                }
            } else {
                LOG(ERROR) << "HTTP: Optaining function \"" << socketContextUpgradeFactoryFunctionName
                           << "\" in plugin failed: " << core::DynamicLoader::dlError();
                core::DynamicLoader::dlClose(handle);
            }
        }
 
        return socketContextUpgradeFactory;
    }

◆ select() [1/2]

template<typename SocketContextUpgradeFactory >

SocketContextUpgradeFactory * web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::select ( const std::string & socketContextUpgradeName )

protected

Definition at line 101 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                                                      {
        SocketContextUpgradeFactory* socketContextUpgradeFactory = nullptr;
 
        if (socketContextUpgradePlugins.contains(socketContextUpgradeName)) {
            socketContextUpgradeFactory = socketContextUpgradePlugins[socketContextUpgradeName].socketContextUpgradeFactory;
        } else if (linkedSocketContextUpgradePlugins.contains(socketContextUpgradeName)) {
            socketContextUpgradeFactory = linkedSocketContextUpgradePlugins[socketContextUpgradeName]();
            add(socketContextUpgradeFactory);
        } else if (!onlyLinked) {
            socketContextUpgradeFactory = load(socketContextUpgradeName);
        }
 
        return socketContextUpgradeFactory;
    }

◆ select() [2/2]

template<typename SocketContextUpgradeFactoryT >

virtual SocketContextUpgradeFactory * web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::select	(	Request &	req,
		Response &	res )

pure virtual

Implemented in web::http::client::SocketContextUpgradeFactorySelector, and web::http::server::SocketContextUpgradeFactorySelector.

◆ unload()

template<typename SocketContextUpgradeFactory >

void web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactory >::unload ( SocketContextUpgradeFactory * socketContextUpgradeFactory )

Definition at line 128 of file SocketContextUpgradeFactorySelector.hpp.

                                                                                                                                     {
        std::string upgradeContextNames = socketContextUpgradeFactory->name();
 
        if (socketContextUpgradePlugins.contains(upgradeContextNames)) {
            SocketContextPlugin socketContextPlugin = socketContextUpgradePlugins[upgradeContextNames];
            socketContextUpgradePlugins.erase(upgradeContextNames);
 
            delete socketContextUpgradeFactory;
 
            if (socketContextPlugin.handle != nullptr) {
                core::DynamicLoader::dlCloseDelayed(socketContextPlugin.handle);
            }
        }
    }

Member Data Documentation

◆ linkedSocketContextUpgradePlugins

template<typename SocketContextUpgradeFactoryT >

std::map<std::string, SocketContextUpgradeFactory* (*) ()> web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::linkedSocketContextUpgradePlugins

private

Definition at line 75 of file SocketContextUpgradeFactorySelector.h.

◆ onlyLinked

template<typename SocketContextUpgradeFactoryT >

bool web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::onlyLinked = false

private

Definition at line 77 of file SocketContextUpgradeFactorySelector.h.

◆ socketContextUpgradePlugins

template<typename SocketContextUpgradeFactoryT >

std::map<std::string, SocketContextPlugin> web::http::SocketContextUpgradeFactorySelector< SocketContextUpgradeFactoryT >::socketContextUpgradePlugins

private

Definition at line 74 of file SocketContextUpgradeFactorySelector.h.

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

web/http/SocketContextUpgradeFactorySelector.h
web/http/SocketContextUpgradeFactorySelector.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Request

◆ Response

◆ SocketContextUpgradeFactory

Constructor & Destructor Documentation

◆ SocketContextUpgradeFactorySelector()

◆ ~SocketContextUpgradeFactorySelector()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ allowDlOpen()

◆ link()

◆ load() [1/2]

◆ load() [2/2]

◆ select() [1/2]

◆ select() [2/2]

◆ unload()

Member Data Documentation

◆ linkedSocketContextUpgradePlugins

◆ onlyLinked

◆ socketContextUpgradePlugins