#include <SubProtocol.h>

Inheritance diagram for web::websocket::server::SubProtocol:

Collaboration diagram for web::websocket::server::SubProtocol:

Public Member Functions
	~SubProtocol () override

void	subscribe (const std::string &group)

void	sendBroadcast (const char *message, std::size_t messageLength, bool excludeSelf=false)

void	sendBroadcast (const std::string &message, bool excludeSelf=false)

void	sendBroadcastStart (const char *message, std::size_t messageLength, bool excludeSelf=false)

void	sendBroadcastStart (const std::string &message, bool excludeSelf=false)

void	sendBroadcastFrame (const char *message, std::size_t messageLength, bool excludeSelf=false)

void	sendBroadcastFrame (const std::string &message, bool excludeSelf=false)

void	sendBroadcastEnd (const char *message, std::size_t messageLength, bool excludeSelf=false)

void	sendBroadcastEnd (const std::string &message, bool excludeSelf=false)

void	forEachClient (const std::function< void(const SubProtocol *)> &sendToClient, bool excludeSelf=false)

Public Member Functions inherited from web::websocket::SubProtocol< web::websocket::server::SocketContextUpgrade >
	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

std::size_t	getPayloadTotalSent () const

std::size_t	getPayloadTotalRead () const

std::string	getOnlineSince () const

std::string	getOnlineDuration () const

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

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

Private Types
using	Super = web::websocket::SubProtocol< web::websocket::server::SocketContextUpgrade >

Private Attributes
std::string	group

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

class	GroupsManager

Additional Inherited Members
Protected Attributes inherited from web::websocket::SubProtocol< web::websocket::server::SocketContextUpgrade >
SubProtocolContext *	subProtocolContext

Detailed Description

Definition at line 63 of file SubProtocol.h.

Member Typedef Documentation

◆ Super

using web::websocket::server::SubProtocol::Super = web::websocket::SubProtocol<web::websocket::server::SocketContextUpgrade>

private

Definition at line 65 of file SubProtocol.h.

Constructor & Destructor Documentation

◆ SubProtocol()

web::websocket::server::SubProtocol::SubProtocol	(	SubProtocolContext *	subProtocolContext,
		const std::string &	name,
		int	pingInterval = `0`,
		int	maxFlyingPings = `3`
	)

protected

Definition at line 53 of file SubProtocol.cpp.

        : Super(subProtocolContext, name, pingInterval, maxFlyingPings) {
        GroupsManager::instance()->subscribe(this);
    }

References web::websocket::server::GroupsManager::instance(), web::websocket::SubProtocol< SocketContextUpgradeT >::SubProtocol(), and web::websocket::server::GroupsManager::subscribe().

Referenced by apps::websocket::subprotocol::echo::server::Echo::Echo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~SubProtocol()

web::websocket::server::SubProtocol::~SubProtocol ( )

overridevirtual

Reimplemented from web::websocket::SubProtocol< web::websocket::server::SocketContextUpgrade >.

Definition at line 58 of file SubProtocol.cpp.

                              {
        GroupsManager::instance()->unsubscribe(this);
    }

References web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::unsubscribe().

Here is the call graph for this function:

Member Function Documentation

◆ forEachClient()

void web::websocket::server::SubProtocol::forEachClient	(	const std::function< void(const SubProtocol *)> &	sendToClient,
		bool	excludeSelf = `false`
	)

Definition at line 101 of file SubProtocol.cpp.

                                                                                                               {
        GroupsManager::instance()->forEachClient(group, sendToClient, excludeSelf ? this : nullptr);
    }

References web::websocket::server::GroupsManager::forEachClient(), group, and web::websocket::server::GroupsManager::instance().

Here is the call graph for this function:

◆ sendBroadcast() [1/2]

void web::websocket::server::SubProtocol::sendBroadcast	(	const char *	message,
		std::size_t	messageLength,
		bool	excludeSelf = `false`
	)

Definition at line 73 of file SubProtocol.cpp.

                                                                                                  {
        GroupsManager::instance()->sendBroadcast(group, message, messageLength, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcast().

Here is the call graph for this function:

◆ sendBroadcast() [2/2]

void web::websocket::server::SubProtocol::sendBroadcast	(	const std::string &	message,
		bool	excludeSelf = `false`
	)

Definition at line 69 of file SubProtocol.cpp.

                                                                              {
        GroupsManager::instance()->sendBroadcast(group, message, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcast().

Referenced by apps::websocket::subprotocol::echo::server::Echo::onMessageEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendBroadcastEnd() [1/2]

void web::websocket::server::SubProtocol::sendBroadcastEnd	(	const char *	message,
		std::size_t	messageLength,
		bool	excludeSelf = `false`
	)

Definition at line 93 of file SubProtocol.cpp.

                                                                                                     {
        GroupsManager::instance()->sendBroadcastEnd(group, message, messageLength, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastEnd().

Here is the call graph for this function:

◆ sendBroadcastEnd() [2/2]

void web::websocket::server::SubProtocol::sendBroadcastEnd	(	const std::string &	message,
		bool	excludeSelf = `false`
	)

Definition at line 97 of file SubProtocol.cpp.

                                                                                 {
        GroupsManager::instance()->sendBroadcastEnd(group, message.data(), message.length(), excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastEnd().

Here is the call graph for this function:

◆ sendBroadcastFrame() [1/2]

void web::websocket::server::SubProtocol::sendBroadcastFrame	(	const char *	message,
		std::size_t	messageLength,
		bool	excludeSelf = `false`
	)

Definition at line 85 of file SubProtocol.cpp.

                                                                                                       {
        GroupsManager::instance()->sendBroadcastFrame(group, message, messageLength, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastFrame().

Here is the call graph for this function:

◆ sendBroadcastFrame() [2/2]

void web::websocket::server::SubProtocol::sendBroadcastFrame	(	const std::string &	message,
		bool	excludeSelf = `false`
	)

Definition at line 89 of file SubProtocol.cpp.

                                                                                   {
        GroupsManager::instance()->sendBroadcastFrame(group, message.data(), message.length(), excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastFrame().

Here is the call graph for this function:

◆ sendBroadcastStart() [1/2]

void web::websocket::server::SubProtocol::sendBroadcastStart	(	const char *	message,
		std::size_t	messageLength,
		bool	excludeSelf = `false`
	)

Definition at line 77 of file SubProtocol.cpp.

                                                                                                       {
        GroupsManager::instance()->sendBroadcastStart(group, message, messageLength, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastStart().

Here is the call graph for this function:

◆ sendBroadcastStart() [2/2]

void web::websocket::server::SubProtocol::sendBroadcastStart	(	const std::string &	message,
		bool	excludeSelf = `false`
	)

Definition at line 81 of file SubProtocol.cpp.

                                                                                   {
        GroupsManager::instance()->sendBroadcastStart(group, message, excludeSelf ? this : nullptr);
    }

References group, web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::sendBroadcastStart().

Here is the call graph for this function:

◆ subscribe()

void web::websocket::server::SubProtocol::subscribe ( const std::string & group )

Definition at line 62 of file SubProtocol.cpp.

                                                      {
        GroupsManager::instance()->subscribe(this, group);
        // subscibe(group, this);
        // unsubscribe(this->group, this);
        // this->group = group;
    }

References web::websocket::server::GroupsManager::instance(), and web::websocket::server::GroupsManager::subscribe().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ GroupsManager

friend class GroupsManager

friend

Definition at line 104 of file SubProtocol.h.

◆ web::websocket::SocketContextUpgrade

template<typename RequestT , typename ResponseT , typename SubProtocolT >

friend class web::websocket::SocketContextUpgrade

friend

Definition at line 102 of file SubProtocol.h.

Member Data Documentation

◆ group

std::string web::websocket::server::SubProtocol::group

private

Definition at line 99 of file SubProtocol.h.

Referenced by forEachClient(), sendBroadcast(), sendBroadcast(), sendBroadcastEnd(), sendBroadcastEnd(), sendBroadcastFrame(), sendBroadcastFrame(), sendBroadcastStart(), sendBroadcastStart(), web::websocket::server::GroupsManager::subscribe(), and web::websocket::server::GroupsManager::unsubscribe().

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

web/websocket/server/SubProtocol.h
web/websocket/server/SubProtocol.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ SubProtocol()

◆ ~SubProtocol()

Member Function Documentation

◆ forEachClient()

◆ sendBroadcast() [1/2]

◆ sendBroadcast() [2/2]

◆ sendBroadcastEnd() [1/2]

◆ sendBroadcastEnd() [2/2]

◆ sendBroadcastFrame() [1/2]

◆ sendBroadcastFrame() [2/2]

◆ sendBroadcastStart() [1/2]

◆ sendBroadcastStart() [2/2]

◆ subscribe()

Friends And Related Symbol Documentation

◆ GroupsManager

◆ web::websocket::SocketContextUpgrade

Member Data Documentation

◆ group