web::websocket::client::SubProtocol Class Reference

#include <SubProtocol.h>

Inheritance diagram for web::websocket::client::SubProtocol:

Collaboration diagram for web::websocket::client::SubProtocol:

Public Member Functions
	~SubProtocol () override
void	sendMessage (const char *message, std::size_t messageLength) const
void	sendMessage (const std::string &message) const
void	sendMessageEnd (const char *message, std::size_t messageLength) const
void	sendMessageEnd (const std::string &message) const
void	sendMessageFrame (const char *message, std::size_t messageLength) const
void	sendMessageFrame (const std::string &message) const
void	sendMessageStart (const char *message, std::size_t messageLength) const
void	sendMessageStart (const std::string &message) const
void	sendClose (uint16_t statusCode=1000, const char *reason=nullptr, std::size_t reasonLength=0)
Public Member Functions inherited from web::websocket::SubProtocol< web::websocket::client::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

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

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

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

Detailed Description

Definition at line 59 of file SubProtocol.h.

Member Typedef Documentation

Super

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

private

Definition at line 61 of file SubProtocol.h.

Constructor & Destructor Documentation

~SubProtocol()

web::websocket::client::SubProtocol::~SubProtocol ( )

overridevirtual

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

Reimplemented in iot::mqtt::SubProtocol< web::websocket::client::SubProtocol >.

Definition at line 52 of file SubProtocol.cpp.

                              {
    }

Member Function Documentation

sendClose()

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

sendMessage() [1/2]

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

sendMessage() [2/2]

void web::websocket::SubProtocol< web::websocket::client::SocketContextUpgrade >::sendMessage

(

const std::string &

message

)

const

sendMessageEnd() [1/2]

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

sendMessageEnd() [2/2]

void web::websocket::SubProtocol< web::websocket::client::SocketContextUpgrade >::sendMessageEnd

(

const std::string &

message

)

const

sendMessageFrame() [1/2]

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

sendMessageFrame() [2/2]

void web::websocket::SubProtocol< web::websocket::client::SocketContextUpgrade >::sendMessageFrame

(

const std::string &

message

)

const

sendMessageStart() [1/2]

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

sendMessageStart() [2/2]

void web::websocket::SubProtocol< web::websocket::client::SocketContextUpgrade >::sendMessageStart

(

const std::string &

message

)

const

Friends And Related Symbol Documentation

web::websocket::SocketContextUpgrade

template<typename RequestT, typename ResponseT, typename SubProtocolT>

friend class web::websocket::SocketContextUpgrade

friend

Definition at line 79 of file SubProtocol.h.

---

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

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