#include <SubProtocol.h>

Collaboration diagram for web::websocket::SubProtocol< SocketContextUpgradeT >:

Public Member Functions
	SubProtocol (SubProtocol &)=delete

	SubProtocol (SubProtocol &&)=delete

SubProtocol &	operator= (SubProtocol &)=delete

SubProtocol &	operator= (SubProtocol &&)=delete

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

void	sendMessage (const std::string &message) const

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

void	sendMessageStart (const std::string &message) const

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

void	sendMessageFrame (const std::string &message) const

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

void	sendMessageEnd (const std::string &message) const

void	sendPing (const char *reason=nullptr, std::size_t reasonLength=0) const

void	sendClose (uint16_t statusCode=1000, const char *reason=nullptr, std::size_t reasonLength=0)

const std::string &	getName ()

core::socket::stream::SocketConnection *	getSocketConnection () const

Protected Member Functions
	SubProtocol (SubProtocolContext *subProtocolContext, const std::string &name, int pingInterval=60, int maxFlyingPings=3)

virtual	~SubProtocol ()

Protected Attributes
SubProtocolContext *	subProtocolContext

Private Types
using	SocketContextUpgrade = SocketContextUpgradeT

Private Member Functions
virtual void	onConnected ()=0

virtual void	onDisconnected ()=0

virtual bool	onSignal (int sig)=0

virtual void	onMessageStart (int opCode)=0

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

virtual void	onMessageEnd ()=0

virtual void	onMessageError (uint16_t errnum)=0

virtual void	onPongReceived ()

Private Attributes
const std::string	name

core::timer::Timer	pingTimer

int	flyingPings = 0

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

Detailed Description

template<typename SocketContextUpgradeT>
class web::websocket::SubProtocol< SocketContextUpgradeT >

Definition at line 46 of file SubProtocol.h.

Member Typedef Documentation

◆ SocketContextUpgrade

template<typename SocketContextUpgradeT >

using web::websocket::SubProtocol< SocketContextUpgradeT >::SocketContextUpgrade = SocketContextUpgradeT

private

Definition at line 55 of file SubProtocol.h.

Constructor & Destructor Documentation

◆ SubProtocol() [1/3]

template<typename SocketContextUpgradeT >

web::websocket::SubProtocol< SocketContextUpgradeT >::SubProtocol ( SubProtocol< SocketContextUpgradeT > & )

delete

◆ SubProtocol() [2/3]

template<typename SocketContextUpgradeT >

web::websocket::SubProtocol< SocketContextUpgradeT >::SubProtocol ( SubProtocol< SocketContextUpgradeT > && )

delete

◆ SubProtocol() [3/3]

template<typename SocketContextUpgrade >

web::websocket::SubProtocol< SocketContextUpgrade >::SubProtocol	(	SubProtocolContext *	subProtocolContext,
		const std::string &	name,
		int	pingInterval = 60,
		int	maxFlyingPings = 3 )

protected

Definition at line 37 of file SubProtocol.hpp.

        : name(name)
        , subProtocolContext(subProtocolContext) {
        if (pingInterval > 0) {
            pingTimer = core::timer::Timer::intervalTimer(
                [this, maxFlyingPings](const std::function<void()>& stop) {
                    if (flyingPings < maxFlyingPings) {
                        sendPing();
                        flyingPings++;
                    } else {
                        LOG(WARNING) << getSocketConnection()->getConnectionName() << " WebSocket: MaxFlyingPings exceeded - closing";
 
                        sendClose();
                        stop();
                    }
                },
                pingInterval);
        }
 
        getSocketConnection()->setTimeout(0);
    }

◆ ~SubProtocol()

template<typename SocketContextUpgrade >

web::websocket::SubProtocol< SocketContextUpgrade >::~SubProtocol ( )

protectedvirtual

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

Definition at line 63 of file SubProtocol.hpp.

                                                    {
        pingTimer.cancel();
    }

Member Function Documentation

◆ getName()

template<typename SocketContextUpgrade >

const std::string & web::websocket::SubProtocol< SocketContextUpgrade >::getName ( )

Definition at line 127 of file SubProtocol.hpp.

                                                                {
        return name;
    }

◆ getSocketConnection()

template<typename SocketContextUpgrade >

core::socket::stream::SocketConnection * web::websocket::SubProtocol< SocketContextUpgrade >::getSocketConnection ( ) const

Definition at line 132 of file SubProtocol.hpp.

                                                                                                   {
        return subProtocolContext->getSocketConnection();
    }

◆ onConnected()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onConnected ( )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onDisconnected()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onDisconnected ( )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onMessageData()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onMessageData	(	const char *	chunk,
		std::size_t	chunkLen )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onMessageEnd()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onMessageEnd ( )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onMessageError()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onMessageError ( uint16_t errnum )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onMessageStart()

template<typename SocketContextUpgradeT >

virtual void web::websocket::SubProtocol< SocketContextUpgradeT >::onMessageStart ( int opCode )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ onPongReceived()

template<typename SocketContextUpgrade >

void web::websocket::SubProtocol< SocketContextUpgrade >::onPongReceived ( )

privatevirtual

Definition at line 120 of file SubProtocol.hpp.

                                                           {
        LOG(DEBUG) << subProtocolContext->getSocketConnection()->getConnectionName() << " WebSocket: Pong received";
 
        flyingPings = 0;
    }

◆ onSignal()

template<typename SocketContextUpgradeT >

virtual bool web::websocket::SubProtocol< SocketContextUpgradeT >::onSignal ( int sig )

privatepure virtual

Implemented in apps::websocket::subprotocol::echo::client::Echo, and apps::websocket::subprotocol::echo::server::Echo.

◆ operator=() [1/2]

template<typename SocketContextUpgradeT >

SubProtocol & web::websocket::SubProtocol< SocketContextUpgradeT >::operator= ( SubProtocol< SocketContextUpgradeT > && )

delete

◆ operator=() [2/2]

template<typename SocketContextUpgradeT >

SubProtocol & web::websocket::SubProtocol< SocketContextUpgradeT >::operator= ( SubProtocol< SocketContextUpgradeT > & )

delete

◆ sendClose()

template<typename SocketContextUpgrade >

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

Definition at line 115 of file SubProtocol.hpp.

                                                                                                                     {
        subProtocolContext->sendClose(statusCode, reason, reasonLength);
    }

◆ sendMessage() [1/2]

template<typename SocketContextUpgrade >

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

Definition at line 68 of file SubProtocol.hpp.

                                                                                                          {
        subProtocolContext->sendMessage(2, message, messageLength);
    }

◆ sendMessage() [2/2]

template<typename SocketContextUpgrade >

void web::websocket::SubProtocol< SocketContextUpgrade >::sendMessage ( const std::string & message ) const

Definition at line 73 of file SubProtocol.hpp.

                                                                                      {
        subProtocolContext->sendMessage(1, message.data(), message.length());
    }

◆ sendMessageEnd() [1/2]

template<typename SocketContextUpgrade >

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

Definition at line 98 of file SubProtocol.hpp.

                                                                                                             {
        subProtocolContext->sendMessageEnd(message, messageLength);
    }

◆ sendMessageEnd() [2/2]

template<typename SocketContextUpgrade >

void web::websocket::SubProtocol< SocketContextUpgrade >::sendMessageEnd ( const std::string & message ) const

Definition at line 103 of file SubProtocol.hpp.

                                                                                         {
        sendMessageEnd(message.data(), message.length());
    }

◆ sendMessageFrame() [1/2]

template<typename SocketContextUpgrade >

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

Definition at line 88 of file SubProtocol.hpp.

                                                                                                               {
        subProtocolContext->sendMessageFrame(message, messageLength);
    }

◆ sendMessageFrame() [2/2]

template<typename SocketContextUpgrade >

void web::websocket::SubProtocol< SocketContextUpgrade >::sendMessageFrame ( const std::string & message ) const

Definition at line 93 of file SubProtocol.hpp.

                                                                                           {
        sendMessageFrame(message.data(), message.length());
    }

◆ sendMessageStart() [1/2]

template<typename SocketContextUpgrade >

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

Definition at line 78 of file SubProtocol.hpp.

                                                                                                               {
        subProtocolContext->sendMessageStart(2, message, messageLength);
    }

◆ sendMessageStart() [2/2]

template<typename SocketContextUpgrade >

void web::websocket::SubProtocol< SocketContextUpgrade >::sendMessageStart ( const std::string & message ) const

Definition at line 83 of file SubProtocol.hpp.

                                                                                           {
        subProtocolContext->sendMessageStart(1, message.data(), message.length());
    }

◆ sendPing()

template<typename SocketContextUpgrade >

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

Definition at line 108 of file SubProtocol.hpp.

                                                                                                     {
        LOG(DEBUG) << getSocketConnection()->getConnectionName() << " WebSocket: Ping sent";
 
        subProtocolContext->sendPing(reason, reasonLength);
    }

Friends And Related Symbol Documentation

◆ web::websocket::SocketContextUpgrade

template<typename SocketContextUpgradeT >

template<typename SubProtocolT , typename RequestT , typename ResponseT >

friend class web::websocket::SocketContextUpgrade

friend

Definition at line 103 of file SubProtocol.h.

Member Data Documentation

◆ flyingPings

template<typename SocketContextUpgradeT >

int web::websocket::SubProtocol< SocketContextUpgradeT >::flyingPings = 0

private

Definition at line 100 of file SubProtocol.h.

◆ name

template<typename SocketContextUpgradeT >

const std::string web::websocket::SubProtocol< SocketContextUpgradeT >::name

private

Definition at line 93 of file SubProtocol.h.

◆ pingTimer

template<typename SocketContextUpgradeT >

core::timer::Timer web::websocket::SubProtocol< SocketContextUpgradeT >::pingTimer

private

Definition at line 99 of file SubProtocol.h.

◆ subProtocolContext

template<typename SocketContextUpgradeT >

SubProtocolContext* web::websocket::SubProtocol< SocketContextUpgradeT >::subProtocolContext

protected

Definition at line 96 of file SubProtocol.h.

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

web/websocket/SubProtocol.h
web/websocket/SubProtocol.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ SocketContextUpgrade

Constructor & Destructor Documentation

◆ SubProtocol() [1/3]

◆ SubProtocol() [2/3]

◆ SubProtocol() [3/3]

◆ ~SubProtocol()

Member Function Documentation

◆ getName()

◆ getSocketConnection()

◆ onConnected()

◆ onDisconnected()

◆ onMessageData()

◆ onMessageEnd()

◆ onMessageError()

◆ onMessageStart()

◆ onPongReceived()

◆ onSignal()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ sendClose()

◆ sendMessage() [1/2]

◆ sendMessage() [2/2]

◆ sendMessageEnd() [1/2]

◆ sendMessageEnd() [2/2]

◆ sendMessageFrame() [1/2]

◆ sendMessageFrame() [2/2]

◆ sendMessageStart() [1/2]

◆ sendMessageStart() [2/2]

◆ sendPing()

Friends And Related Symbol Documentation

◆ web::websocket::SocketContextUpgrade

Member Data Documentation

◆ flyingPings

◆ name

◆ pingTimer

◆ subProtocolContext