#include <SocketContextUpgrade.h>

Inheritance diagram for web::websocket::server::SocketContextUpgrade:

Collaboration diagram for web::websocket::server::SocketContextUpgrade:

Public Member Functions
	SocketContextUpgrade (core::socket::stream::SocketConnection socketConnection, web::http::SocketContextUpgradeFactory< web::http::server::Request, web::http::server::Response > socketContextUpgradeFactory)

	~SocketContextUpgrade () override

std::string	loadSubProtocol (const std::list< std::string > &subProtocolNames)

Public Member Functions inherited from web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >
	SocketContextUpgrade ()=delete

	SocketContextUpgrade (const SocketContextUpgrade &)=delete

SocketContextUpgrade &	operator= (const SocketContextUpgrade &)=delete

	~SocketContextUpgrade () override=default

Public Member Functions inherited from core::socket::stream::SocketContext
	SocketContext (core::socket::stream::SocketConnection *socketConnection)

void	sendToPeer (const char *chunk, std::size_t chunkLen) const final

bool	streamToPeer (core::pipe::Source *source) const

void	streamEof ()

std::size_t	readFromPeer (char *chunk, std::size_t chunklen) const final

void	setTimeout (const utils::Timeval &timeout) final

void	shutdownRead ()

void	shutdownWrite (bool forceClose=false)

void	close () override

SocketConnection *	getSocketConnection () const

virtual void	switchSocketContext (SocketContext *newSocketContext)

void	sendToPeer (const std::string &data) const

virtual void	sendToPeer (const char *chunk, std::size_t chunkLen) const=0

Public Member Functions inherited from core::socket::SocketContext
	SocketContext (const SocketContext &)=delete

	SocketContext (SocketContext &&)=delete

SocketContext &	operator= (const SocketContext &)=delete

SocketContext &	operator= (SocketContext &&)=delete

void	sendToPeer (const std::string &data) const

Public Member Functions inherited from web::websocket::SubProtocolContext
	SubProtocolContext (core::socket::stream::SocketConnection *socketConnection, bool role)

	SubProtocolContext (const SubProtocolContext &)=delete

	~SubProtocolContext () override

SubProtocolContext &	operator= (const SubProtocolContext &)=delete

Private Attributes
web::websocket::SubProtocolFactory< SubProtocol > *	subProtocolFactory = nullptr

Additional Inherited Members
Public Types inherited from web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >
using	SubProtocol = SubProtocol

using	Request = web::http::server::Request

using	Response = web::http::server::Response

Public Types inherited from web::websocket::SubProtocolContext
enum	OpCode { CONTINUATION = 0x00 , TEXT = 0x01 , BINARY = 0x02 , CLOSE = 0x08 , PING = 0x09 , PONG = 0x0A }

Protected Types inherited from web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >
enum	Role

Protected Types inherited from web::http::SocketContextUpgrade< RequestT, ResponseT >
using	Request = RequestT

using	Response = ResponseT

using	SocketContextUpgradeFactory = web::http::SocketContextUpgradeFactory< Request, Response >

Protected Member Functions inherited from web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >
	SocketContextUpgrade (core::socket::stream::SocketConnection socketConnection, web::http::SocketContextUpgradeFactory< Request, Response > socketContextUpgradeFactory, Role role)

Protected Member Functions inherited from web::http::SocketContextUpgrade< RequestT, ResponseT >
	SocketContextUpgrade (core::socket::stream::SocketConnection socketConnection, SocketContextUpgradeFactory socketContextUpgradeFactory)

	~SocketContextUpgrade () override

Protected Member Functions inherited from core::socket::stream::SocketContext
void	onWriteError (int errnum) override

void	onReadError (int errnum) override

Protected Member Functions inherited from core::socket::SocketContext
	SocketContext ()=default

virtual	~SocketContext ()

Protected Member Functions inherited from web::websocket::Receiver
	Receiver (core::socket::stream::SocketConnection *socketConnection)

	Receiver (const Receiver &)=delete

Receiver &	operator= (const Receiver &)=delete

virtual	~Receiver ()

std::size_t	receive ()

Protected Member Functions inherited from web::websocket::Transmitter
	Transmitter (core::socket::stream::SocketConnection *socketConnection, bool masking)

void	sendMessage (uint8_t opCode, const char *message, std::size_t messageLength)

void	sendMessageStart (uint8_t opCode, const char *message, std::size_t messageLength)

void	sendMessageFrame (const char *message, std::size_t messageLength)

void	sendMessageEnd (const char *message, std::size_t messageLength)

	Transmitter ()=delete

	Transmitter (const Transmitter &)=delete

Transmitter &	operator= (const Transmitter &)=delete

virtual	~Transmitter ()

Protected Attributes inherited from web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >
SubProtocol *	subProtocol

Protected Attributes inherited from web::websocket::Transmitter
bool	closeSent = false

Detailed Description

Definition at line 73 of file SocketContextUpgrade.h.

Constructor & Destructor Documentation

◆ SocketContextUpgrade()

web::websocket::server::SocketContextUpgrade::SocketContextUpgrade	(	core::socket::stream::SocketConnection *	socketConnection,
		web::http::SocketContextUpgradeFactory< web::http::server::Request, web::http::server::Response > *	socketContextUpgradeFactory
	)

Definition at line 54 of file SocketContextUpgrade.cpp.

        : web::websocket::SocketContextUpgrade<SubProtocol, web::http::server::Request, web::http::server::Response>(
              socketConnection, socketContextUpgradeFactory, Role::SERVER) {
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::SocketContextUpgrade(), and web::websocket::client::SubProtocol::web::websocket::SocketContextUpgrade.

Referenced by web::websocket::server::SocketContextUpgradeFactory::create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~SocketContextUpgrade()

web::websocket::server::SocketContextUpgrade::~SocketContextUpgrade ( )

override

Definition at line 61 of file SocketContextUpgrade.cpp.

                                                {
        if (subProtocolFactory != nullptr && subProtocolFactory->deleteSubProtocol(subProtocol) == 0) {
            SubProtocolFactorySelector::instance()->unload(subProtocolFactory);
        }
 
        subProtocol = nullptr;
    }

References web::websocket::SubProtocolFactory< SubProtocolT >::deleteSubProtocol(), web::websocket::server::SubProtocolFactorySelector::instance(), and subProtocolFactory.

Here is the call graph for this function:

Member Function Documentation

◆ loadSubProtocol()

std::string web::websocket::server::SocketContextUpgrade::loadSubProtocol ( const std::list< std::string > & subProtocolNames )

Definition at line 69 of file SocketContextUpgrade.cpp.

                                                                                              {
        std::string selectedSubProtocolName;
 
        for (const std::string& subProtocolName : subProtocolNames) {
            subProtocolFactory = SubProtocolFactorySelector::instance()->select(subProtocolName, SubProtocolFactorySelector::Role::SERVER);
 
            if (subProtocolFactory != nullptr) {
                subProtocol = subProtocolFactory->createSubProtocol(this);
                selectedSubProtocolName = subProtocol != nullptr ? subProtocolName : "";
            }
 
            if (!selectedSubProtocolName.empty()) {
                break;
            }
        }
 
        return selectedSubProtocolName;
    }