web::websocket::client::SocketContextUpgradeFactory Class Reference

#include <SocketContextUpgradeFactory.h>

Inheritance diagram for web::websocket::client::SocketContextUpgradeFactory:

Collaboration diagram for web::websocket::client::SocketContextUpgradeFactory:

Public Member Functions
	SocketContextUpgradeFactory ()=default
Public Member Functions inherited from web::http::client::SocketContextUpgradeFactory
void	checkRefCount () final
Public Member Functions inherited from core::socket::stream::SocketContextFactory
	SocketContextFactory (SocketContextFactory &)=delete
	SocketContextFactory (SocketContextFactory &&)=delete
SocketContextFactory &	operator= (SocketContextFactory &)=delete
SocketContextFactory &	operator= (SocketContextFactory &&)=delete
virtual core::socket::stream::SocketContext *	create (core::socket::stream::SocketConnection *socketConnection)=0

Static Public Member Functions
static void	link ()
Static Public Member Functions inherited from web::http::client::SocketContextUpgradeFactory
static void	link (const std::string &upgradeContextName, SocketContextUpgradeFactory *(*linkedPlugin)())

Private Member Functions
void	prepare (web::http::client::Request &request) override
std::string	name () override
http::SocketContextUpgrade< web::http::client::Request, web::http::client::Response > *	create (core::socket::stream::SocketConnection *socketConnection, web::http::client::Request *request, web::http::client::Response *response) override

Additional Inherited Members
Public Types inherited from web::http::client::SocketContextUpgradeFactory
using	Resquest = web::http::client::Request
using	Reponse = web::http::client::Response
Public Types inherited from web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response >
using	Request
using	Response
Protected Member Functions inherited from web::http::client::SocketContextUpgradeFactory
	SocketContextUpgradeFactory ()
Protected Member Functions inherited from web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response >
	SocketContextUpgradeFactory ()=default
	~SocketContextUpgradeFactory () override=default
void	prepare (Request &request, Response &response)
Protected Member Functions inherited from core::socket::stream::SocketContextFactory
	SocketContextFactory ()=default
virtual	~SocketContextFactory ()
Protected Attributes inherited from web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response >
std::size_t	refCount

Detailed Description

Definition at line 55 of file SocketContextUpgradeFactory.h.

Constructor & Destructor Documentation

SocketContextUpgradeFactory()

web::websocket::client::SocketContextUpgradeFactory::SocketContextUpgradeFactory ( )

default

Referenced by web::websocket::client::websocketClientSocketContextUpgradeFactory().

Here is the caller graph for this function:

Member Function Documentation

create()

http::SocketContextUpgrade< web::http::client::Request, web::http::client::Response > * web::websocket::client::SocketContextUpgradeFactory::create ( core::socket::stream::SocketConnection * socketConnection, web::http::client::Request * request, web::http::client::Response * response )

overrideprivatevirtual

Implements web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response >.

Definition at line 99 of file SocketContextUpgradeFactory.cpp.

                                                                         {
        SocketContextUpgrade* socketContext = nullptr;
 
        if (response->get("sec-websocket-accept") == base64::serverWebSocketKey(request->header("Sec-WebSocket-Key"))) {
            const std::string subProtocolName = response->get("sec-websocket-protocol");
 
            socketContext = new SocketContextUpgrade(socketConnection, this);
            const std::string selectedSubProtocolName = socketContext->loadSubProtocol(subProtocolName);
 
            if (selectedSubProtocolName.empty()) {
                delete socketContext;
                socketContext = nullptr;
            }
        } else {
            checkRefCount();
        }
 
        return socketContext;
    }

References web::http::client::SocketContextUpgradeFactory::checkRefCount(), web::http::client::Response::get(), web::http::client::Request::header(), web::websocket::client::SocketContextUpgrade::loadSubProtocol(), base64::serverWebSocketKey(), and web::websocket::client::SocketContextUpgrade::SocketContextUpgrade().

Here is the call graph for this function:

link()

void web::websocket::client::SocketContextUpgradeFactory::link ( )

static

Definition at line 121 of file SocketContextUpgradeFactory.cpp.

                                           {
        static bool linked = false;
 
        if (!linked) {
            web::http::client::SocketContextUpgradeFactory::link("websocket", websocketClientSocketContextUpgradeFactory);
            linked = true;
        }
    }

References web::http::client::SocketContextUpgradeFactory::link(), and web::websocket::client::websocketClientSocketContextUpgradeFactory().

Here is the call graph for this function:

name()

std::string web::websocket::client::SocketContextUpgradeFactory::name ( )

overrideprivatevirtual

Implements web::http::SocketContextUpgradeFactory< web::http::client::Request, web::http::client::Response >.

Definition at line 94 of file SocketContextUpgradeFactory.cpp.

                                                {
        return "websocket";
    }

prepare()

void web::websocket::client::SocketContextUpgradeFactory::prepare ( web::http::client::Request & request )

overrideprivatevirtual

Implements web::http::client::SocketContextUpgradeFactory.

Definition at line 86 of file SocketContextUpgradeFactory.cpp.

                                                                        {
        unsigned char ebytes[16];
        getentropy(ebytes, 16);
 
        request.set("Sec-WebSocket-Key", base64::base64_encode(ebytes, 16));
        request.set("Sec-WebSocket-Version", "13");
    }

References base64::base64_encode(), web::websocket::client::getentropy(), and web::http::client::Request::set().

Here is the call graph for this function:

---

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

• web/websocket/client/SocketContextUpgradeFactory.h
• web/websocket/client/SocketContextUpgradeFactory.cpp