web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT > Class Template Reference

#include <SocketContextUpgrade.h>

Inheritance diagram for web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >:

Collaboration diagram for web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >:

Public Types
using	SubProtocol = SubProtocolT
using	Request = RequestT
using	Response = ResponseT
Public Types inherited from web::websocket::SubProtocolContext
enum	OpCode {   CONTINUATION = 0x00 , TEXT = 0x01 , BINARY = 0x02 , CLOSE = 0x08 ,   PING = 0x09 , PONG = 0x0A }

Public Member Functions
	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
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

Protected Types
enum class	Role { SERVER , CLIENT }
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
	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
SubProtocol *	subProtocol = nullptr
Protected Attributes inherited from web::websocket::Transmitter
bool	closeSent = false

Private Types
using	Super = web::http::SocketContextUpgrade<RequestT, ResponseT>

Private Member Functions
void	sendMessage (uint8_t opCode, const char *message, std::size_t messageLength) override
void	sendMessageStart (uint8_t opCode, const char *message, std::size_t messageLength) override
void	sendMessageFrame (const char *message, std::size_t messageLength) override
void	sendMessageEnd (const char *message, std::size_t messageLength) override
void	sendPing (const char *reason=nullptr, std::size_t reasonLength=0) override
void	sendPong (const char *reason=nullptr, std::size_t reasonLength=0) override
void	sendClose (uint16_t statusCode=1000, const char *reason=nullptr, std::size_t reasonLength=0) override
void	sendClose (const char *message, std::size_t messageLength) override
core::socket::stream::SocketConnection *	getSocketConnection () override
void	onMessageStart (int opCode) override
void	onMessageData (const char *chunk, uint64_t chunkLen) override
void	onMessageEnd () override
void	onMessageError (uint16_t errnum) override
void	onConnected () override
void	onDisconnected () override
bool	onSignal (int sig) override
std::size_t	onReceivedFromPeer () override

Private Attributes
int	receivedOpCode = 0
std::string	pongCloseData

Detailed Description

template<typename SubProtocolT, typename RequestT, typename ResponseT>
class web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >

Definition at line 31 of file SubProtocol.h.

Member Typedef Documentation

Request

template<typename SubProtocolT , typename RequestT , typename ResponseT >

using web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::Request = RequestT

Definition at line 69 of file SocketContextUpgrade.h.

Response

template<typename SubProtocolT , typename RequestT , typename ResponseT >

using web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::Response = ResponseT

Definition at line 70 of file SocketContextUpgrade.h.

SubProtocol

template<typename SubProtocolT , typename RequestT , typename ResponseT >

using web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::SubProtocol = SubProtocolT

Definition at line 68 of file SocketContextUpgrade.h.

Super

template<typename SubProtocolT , typename RequestT , typename ResponseT >

using web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::Super = web::http::SocketContextUpgrade<RequestT, ResponseT>

private

Definition at line 65 of file SocketContextUpgrade.h.

Member Enumeration Documentation

Role

template<typename SubProtocolT , typename RequestT , typename ResponseT >

enum class web::websocket::SocketContextUpgrade::Role

strongprotected

Enumerator
SERVER
CLIENT

Definition at line 79 of file SocketContextUpgrade.h.

{ SERVER, CLIENT };

Constructor & Destructor Documentation

SocketContextUpgrade() [1/3]

template<typename SubProtocolT , typename RequestT , typename ResponseT >

web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::SocketContextUpgrade ( )

delete

SocketContextUpgrade() [2/3]

template<typename SubProtocolT , typename RequestT , typename ResponseT >

web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::SocketContextUpgrade ( const SocketContextUpgrade< SubProtocolT, RequestT, ResponseT > & )

delete

SocketContextUpgrade() [3/3]

template<typename SubProtocol , typename Request , typename Response >

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

protected

Definition at line 32 of file SocketContextUpgrade.hpp.

        : Super(socketConnection, socketContextUpgradeFactory)
        , SubProtocolContext(socketConnection, role == Role::CLIENT) {
    }

~SocketContextUpgrade()

template<typename SubProtocolT , typename RequestT , typename ResponseT >

web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::~SocketContextUpgrade ( )

overridedefault

Member Function Documentation

getSocketConnection()

template<typename SubProtocol , typename Request , typename Response >

core::socket::stream::SocketConnection * web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::getSocketConnection ( )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 102 of file SocketContextUpgrade.hpp.

                                                                                                                {
        return web::http::SocketContextUpgrade<Request, Response>::getSocketConnection();
    }

onConnected()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onConnected ( )

overrideprivatevirtual

Implements core::socket::stream::SocketContext.

Definition at line 180 of file SocketContextUpgrade.hpp.

                                                                           {
        LOG(INFO) << getSocketConnection()->getConnectionName() << " WebSocket: connected";
        subProtocol->onConnected();
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol.

onDisconnected()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onDisconnected ( )

overrideprivatevirtual

Implements core::socket::stream::SocketContext.

Definition at line 186 of file SocketContextUpgrade.hpp.

                                                                              {
        subProtocol->onDisconnected();
        LOG(INFO) << getSocketConnection()->getConnectionName() << " WebSocket: disconnected";
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol.

onMessageData()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onMessageData ( const char * chunk, uint64_t chunkLen )

overrideprivatevirtual

Implements web::websocket::Receiver.

Definition at line 124 of file SocketContextUpgrade.hpp.

                                                                                                                 {
        switch (receivedOpCode) {
            case SubProtocolContext::OpCode::CLOSE:
                [[fallthrough]];
            case SubProtocolContext::OpCode::PING:
                [[fallthrough]];
            case SubProtocolContext::OpCode::PONG:
                pongCloseData += std::string(chunk, static_cast<std::size_t>(chunkLen));
                break;
            default:
                std::size_t chunkOffset = 0;
 
                do {
                    std::size_t sendChunkLen =
                        (chunkLen - chunkOffset <= SIZE_MAX) ? static_cast<std::size_t>(chunkLen - chunkOffset) : SIZE_MAX;
                    subProtocol->onMessageData(chunk + chunkOffset, sendChunkLen);
                    chunkOffset += sendChunkLen;
                } while (chunkLen - chunkOffset > 0);
                break;
        }
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::receivedOpCode.

onMessageEnd()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onMessageEnd ( )

overrideprivatevirtual

Implements web::websocket::Receiver.

Definition at line 147 of file SocketContextUpgrade.hpp.

                                                                            {
        switch (receivedOpCode) {
            case SubProtocolContext::OpCode::CLOSE:
                if (closeSent) { // active close
                    closeSent = false;
                    LOG(DEBUG) << getSocketConnection()->getConnectionName() << " WebSocket: Close confirmed from peer";
                } else { // passive close
                    LOG(DEBUG) << getSocketConnection()->getConnectionName() << " WebSocket: Close request received - replying with close";
                    sendClose(pongCloseData.data(), pongCloseData.length());
                    pongCloseData.clear();
                    shutdownWrite();
                }
                break;
            case SubProtocolContext::OpCode::PING:
                sendPong(pongCloseData.data(), pongCloseData.length());
                pongCloseData.clear();
                break;
            case SubProtocolContext::OpCode::PONG:
                subProtocol->onPongReceived();
                break;
            default:
                subProtocol->onMessageEnd();
                break;
        }
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::receivedOpCode, and web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol.

onMessageError()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onMessageError ( uint16_t errnum )

overrideprivatevirtual

Implements web::websocket::Receiver.

Definition at line 174 of file SocketContextUpgrade.hpp.

                                                                                             {
        subProtocol->onMessageError(errnum);
        sendClose(errnum);
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol.

onMessageStart()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onMessageStart ( int opCode )

overrideprivatevirtual

Implements web::websocket::Receiver.

Definition at line 107 of file SocketContextUpgrade.hpp.

                                                                                        {
        receivedOpCode = opCode;
 
        switch (opCode) {
            case SubProtocolContext::OpCode::CLOSE:
                [[fallthrough]];
            case SubProtocolContext::OpCode::PING:
                [[fallthrough]];
            case SubProtocolContext::OpCode::PONG:
                break;
            default:
                subProtocol->onMessageStart(opCode);
                break;
        }
    }

onReceivedFromPeer()

template<typename SubProtocol , typename Request , typename Response >

std::size_t web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onReceivedFromPeer ( )

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 197 of file SocketContextUpgrade.hpp.

                                                                                       {
        return Receiver::receive();
    }

onSignal()

template<typename SubProtocol , typename Request , typename Response >

bool web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::onSignal ( int sig )

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 192 of file SocketContextUpgrade.hpp.

                                                                               {
        return subProtocol->onSignal(sig);
    }

References web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol.

operator=()

template<typename SubProtocolT , typename RequestT , typename ResponseT >

SocketContextUpgrade & web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::operator= ( const SocketContextUpgrade< SubProtocolT, RequestT, ResponseT > & )

delete

sendClose() [1/2]

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendClose ( const char * message, std::size_t messageLength )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 89 of file SocketContextUpgrade.hpp.

                                                                                                                     {
        if (!closeSent) {
            LOG(DEBUG) << this->getSocketConnection()->getConnectionName() << " WebSocket: Sending close to peer";
 
            sendMessage(8, message, messageLength);
 
            setTimeout(CLOSE_SOCKET_TIMEOUT);
 
            closeSent = true;
        }
    }

sendClose() [2/2]

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendClose ( uint16_t statusCode = 1000, const char * reason = nullptr, std::size_t reasonLength = 0 )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 73 of file SocketContextUpgrade.hpp.

                                                                                                                                   {
        std::size_t closePayloadLength = reasonLength + 2;
        char* closePayload = new char[closePayloadLength];
 
        *reinterpret_cast<uint16_t*>(closePayload) = htobe16(statusCode); // cppcheck-suppress uninitdata
 
        if (reasonLength > 0) {
            memcpy(closePayload + 2, reason, reasonLength);
        }
 
        sendClose(closePayload, closePayloadLength);
 
        delete[] closePayload;
    }

sendMessage()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendMessage ( uint8_t opCode, const char * message, std::size_t messageLength )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 41 of file SocketContextUpgrade.hpp.

                                                                                                                                       {
        Transmitter::sendMessage(opCode, message, messageLength);
    }

sendMessageEnd()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendMessageEnd ( const char * message, std::size_t messageLength )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 57 of file SocketContextUpgrade.hpp.

                                                                                                                          {
        Transmitter::sendMessageEnd(message, messageLength);
    }

sendMessageFrame()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendMessageFrame ( const char * message, std::size_t messageLength )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 52 of file SocketContextUpgrade.hpp.

                                                                                                                            {
        Transmitter::sendMessageFrame(message, messageLength);
    }

sendMessageStart()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendMessageStart ( uint8_t opCode, const char * message, std::size_t messageLength )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 47 of file SocketContextUpgrade.hpp.

                                                                                                                                       {
        Transmitter::sendMessageStart(opCode, message, messageLength);
    }

sendPing()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendPing ( const char * reason = nullptr, std::size_t reasonLength = 0 )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 62 of file SocketContextUpgrade.hpp.

                                                                                                                  {
        sendMessage(9, reason, reasonLength);
    }

sendPong()

template<typename SubProtocol , typename Request , typename Response >

void web::websocket::SocketContextUpgrade< SubProtocol, Request, Response >::sendPong ( const char * reason = nullptr, std::size_t reasonLength = 0 )

overrideprivatevirtual

Implements web::websocket::SubProtocolContext.

Definition at line 67 of file SocketContextUpgrade.hpp.

                                                                                                                  {
        sendMessage(10, reason, reasonLength);
    }

Member Data Documentation

pongCloseData

template<typename SubProtocolT , typename RequestT , typename ResponseT >

std::string web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::pongCloseData

private

Definition at line 121 of file SocketContextUpgrade.h.

receivedOpCode

template<typename SubProtocolT , typename RequestT , typename ResponseT >

int web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::receivedOpCode = 0

private

Definition at line 119 of file SocketContextUpgrade.h.

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onMessageData(), and web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onMessageEnd().

subProtocol

template<typename SubProtocolT , typename RequestT , typename ResponseT >

SubProtocol* web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::subProtocol = nullptr

protected

Definition at line 116 of file SocketContextUpgrade.h.

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onConnected(), web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onDisconnected(), web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onMessageEnd(), web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onMessageError(), web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >::onReceivedFromPeer(), and web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::onSignal().

---

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

• web/websocket/SubProtocolFactory.h
• web/websocket/SocketContextUpgrade.h
• web/websocket/SubProtocol.h
• web/websocket/SocketContextUpgrade.hpp