web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT > Class Template Reference

#include <SubProtocolFactorySelector.h>

Collaboration diagram for web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >:

Public Types
enum class	Role { SERVER , CLIENT }
using	SubProtocolFactory = SubProtocolFactoryT

Public Member Functions
	SubProtocolFactorySelector (const SubProtocolFactorySelector &)=delete
SubProtocolFactorySelector &	operator= (const SubProtocolFactorySelector &)=delete
SubProtocolFactory *	select (const std::string &subProtocolName)
SubProtocolFactory *	select (const std::string &subProtocolName, Role role)
template<typename SubProtocolFactory >
void	unload (SubProtocolFactory *subProtocolFactory)

Protected Member Functions
	SubProtocolFactorySelector ()=default
virtual	~SubProtocolFactorySelector ()=default
virtual SubProtocolFactory *	load (const std::string &subProtocolName)=0
void	allowDlOpen ()
template<typename SubProtocolFactory >
void	link (const std::string &subProtocolName, SubProtocolFactory *(*subProtocolFactory)())

Static Protected Member Functions
static SubProtocolFactory *	load (const std::string &subProtocolName, const std::string &subProtocolLibraryFile, const std::string &subProtocolFactoryFunctionName)

Private Attributes
std::map< std::string, SubProtocolFactory * >	subProtocolFactories
std::map< std::string, SubProtocolFactory *(*)()>	linkedSubProtocolFactories
bool	onlyLinked = false

Detailed Description

template<typename SubProtocolFactoryT>
class web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >

Definition at line 57 of file SubProtocolFactorySelector.h.

Member Typedef Documentation

SubProtocolFactory

template<typename SubProtocolFactoryT >

using web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::SubProtocolFactory = SubProtocolFactoryT

Definition at line 62 of file SubProtocolFactorySelector.h.

Member Enumeration Documentation

Role

template<typename SubProtocolFactoryT >

enum class web::websocket::SubProtocolFactorySelector::Role

strong

Enumerator
SERVER
CLIENT

Definition at line 64 of file SubProtocolFactorySelector.h.

{ SERVER, CLIENT };

Constructor & Destructor Documentation

SubProtocolFactorySelector() [1/2]

template<typename SubProtocolFactoryT >

web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::SubProtocolFactorySelector ( const SubProtocolFactorySelector< SubProtocolFactoryT > & )

delete

SubProtocolFactorySelector() [2/2]

template<typename SubProtocolFactoryT >

web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::SubProtocolFactorySelector ( )

protecteddefault

~SubProtocolFactorySelector()

template<typename SubProtocolFactoryT >

virtual web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::~SubProtocolFactorySelector ( )

protectedvirtualdefault

Reimplemented in web::websocket::client::SubProtocolFactorySelector, and web::websocket::server::SubProtocolFactorySelector.

Member Function Documentation

allowDlOpen()

template<typename SubProtocolFactory >

void web::websocket::SubProtocolFactorySelector< SubProtocolFactory >::allowDlOpen ( )

protected

Definition at line 118 of file SubProtocolFactorySelector.hpp.

                                                                     {
        onlyLinked = false;
    }

link()

template<typename SubProtocolFactoryT >

template<typename SubProtocolFactory >

void web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::link ( const std::string & subProtocolName, SubProtocolFactory *(* subProtocolFactory )() )

inlineprotected

Definition at line 99 of file SubProtocolFactorySelector.h.

                                                                                                 {
            onlyLinked = true;
            linkedSubProtocolFactories[subProtocolName] =
                reinterpret_cast<SubProtocolFactorySelector::SubProtocolFactory* (*) ()>(subProtocolFactory);
        }

load() [1/2]

template<typename SubProtocolFactoryT >

virtual SubProtocolFactory * web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::load ( const std::string & subProtocolName )

protectedpure virtual

Implemented in web::websocket::client::SubProtocolFactorySelector, and web::websocket::server::SubProtocolFactorySelector.

load() [2/2]

template<typename SubProtocolFactory >

SubProtocolFactory * web::websocket::SubProtocolFactorySelector< SubProtocolFactory >::load ( const std::string & subProtocolName, const std::string & subProtocolLibraryFile, const std::string & subProtocolFactoryFunctionName )

staticprotected

Definition at line 56 of file SubProtocolFactorySelector.hpp.

                                                                                                                              {
        SubProtocolFactory* subProtocolFactory = nullptr;
 
        void* handle = core::DynamicLoader::dlOpen(subProtocolLibraryFile);
 
        if (handle != nullptr) {
            SubProtocolFactory* (*getSubProtocolFactory)() =
                reinterpret_cast<SubProtocolFactory* (*) ()>(core::DynamicLoader::dlSym(handle, subProtocolFactoryFunctionName));
            if (getSubProtocolFactory != nullptr) {
                subProtocolFactory = getSubProtocolFactory();
                if (subProtocolFactory != nullptr) {
                    subProtocolFactory->setHandle(handle);
                    LOG(DEBUG) << "WebSocket: SubProtocolFactory created successful: " << subProtocolName;
                } else {
                    LOG(DEBUG) << "WebSocket: SubProtocolFactory not created: " << subProtocolName;
                    core::DynamicLoader::dlClose(handle);
                }
            } else {
                LOG(DEBUG) << "WebSocket: Optaining function \"" << subProtocolFactoryFunctionName
                           << "\" in plugin failed: " << core::DynamicLoader::dlError();
                core::DynamicLoader::dlClose(handle);
            }
        }
 
        return subProtocolFactory;
    }

operator=()

template<typename SubProtocolFactoryT >

SubProtocolFactorySelector & web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::operator= ( const SubProtocolFactorySelector< SubProtocolFactoryT > & )

delete

select() [1/2]

template<typename SubProtocolFactory >

SubProtocolFactory * web::websocket::SubProtocolFactorySelector< SubProtocolFactory >::select

(

const std::string &

subProtocolName

)

Definition at line 86 of file SubProtocolFactorySelector.hpp.

                                                                                                               {
        SubProtocolFactory* subProtocolFactory = nullptr;
 
        if (subProtocolFactories.contains(subProtocolName)) {
            subProtocolFactory = subProtocolFactories[subProtocolName];
        }
 
        return subProtocolFactory;
    }

select() [2/2]

template<typename SubProtocolFactory >

SubProtocolFactory * web::websocket::SubProtocolFactorySelector< SubProtocolFactory >::select	(	const std::string &	subProtocolName,
		Role	role )

Definition at line 97 of file SubProtocolFactorySelector.hpp.

                                                                                                           {
        SubProtocolFactory* subProtocolFactory = select(subProtocolName);
 
        if (subProtocolFactory == nullptr) {
            if (linkedSubProtocolFactories.contains(subProtocolName)) {
                SubProtocolFactory* (*plugin)() = linkedSubProtocolFactories[subProtocolName];
                subProtocolFactory = plugin();
            } else if (!onlyLinked) {
                subProtocolFactory = load(subProtocolName);
            }
 
            if (subProtocolFactory != nullptr) {
                subProtocolFactories.insert({subProtocolName, subProtocolFactory});
            }
        }
 
        return subProtocolFactory;
    }

unload()

template<typename SubProtocolFactoryT >

template<typename SubProtocolFactory >

void web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::unload ( SubProtocolFactory * subProtocolFactory )

inline

Definition at line 80 of file SubProtocolFactorySelector.h.

                                                            {
            std::string name = subProtocolFactory->getName();
 
            if (subProtocolFactories.contains(name)) {
                subProtocolFactories.erase(name);
 
                void* handle = subProtocolFactory->getHandle();
                delete subProtocolFactory;
 
                if (handle != nullptr) {
                    core::DynamicLoader::dlCloseDelayed(handle);
                }
            }
        }

Member Data Documentation

linkedSubProtocolFactories

template<typename SubProtocolFactoryT >

std::map<std::string, SubProtocolFactory* (*) ()> web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::linkedSubProtocolFactories

private

Definition at line 107 of file SubProtocolFactorySelector.h.

onlyLinked

template<typename SubProtocolFactoryT >

bool web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::onlyLinked = false

private

Definition at line 109 of file SubProtocolFactorySelector.h.

subProtocolFactories

template<typename SubProtocolFactoryT >

std::map<std::string, SubProtocolFactory*> web::websocket::SubProtocolFactorySelector< SubProtocolFactoryT >::subProtocolFactories

private

Definition at line 106 of file SubProtocolFactorySelector.h.

---

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

• web/websocket/SubProtocolFactorySelector.h
• web/websocket/SubProtocolFactorySelector.hpp