web::websocket::SubProtocolContext Class Reference

#include <SubProtocolContext.h>

Inheritance diagram for web::websocket::SubProtocolContext:

Collaboration diagram for web::websocket::SubProtocolContext:

Public Types
enum	OpCode {   CONTINUATION = 0x00 , TEXT = 0x01 , BINARY = 0x02 , CLOSE = 0x08 ,   PING = 0x09 , PONG = 0x0A }

Public Member Functions
	SubProtocolContext (core::socket::stream::SocketConnection *socketConnection, bool role)
	SubProtocolContext (const SubProtocolContext &)=delete
	~SubProtocolContext () override
SubProtocolContext &	operator= (const SubProtocolContext &)=delete
virtual void	sendMessage (uint8_t opCode, const char *message, std::size_t messageLength)=0
virtual void	sendMessageStart (uint8_t opCode, const char *message, std::size_t messageLength)=0
virtual void	sendMessageFrame (const char *message, std::size_t messageLength)=0
virtual void	sendMessageEnd (const char *message, std::size_t messageLength)=0
virtual void	sendPing (const char *reason=nullptr, std::size_t reasonLength=0)=0
virtual void	sendPong (const char *reason=nullptr, std::size_t reasonLength=0)=0
virtual void	sendClose (uint16_t statusCode=1000, const char *reason=nullptr, std::size_t reasonLength=0)=0
virtual core::socket::stream::SocketConnection *	getSocketConnection ()=0

Private Member Functions
virtual void	sendClose (const char *message, std::size_t messageLength)=0

Additional Inherited Members
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::Transmitter
bool	closeSent = false

Detailed Description

Definition at line 39 of file SubProtocolContext.h.

Member Enumeration Documentation

OpCode

enum web::websocket::SubProtocolContext::OpCode

Enumerator
CONTINUATION
TEXT
BINARY
CLOSE
PING
PONG

Definition at line 61 of file SubProtocolContext.h.

{ CONTINUATION = 0x00, TEXT = 0x01, BINARY = 0x02, CLOSE = 0x08, PING = 0x09, PONG = 0x0A };

Constructor & Destructor Documentation

SubProtocolContext() [1/2]

web::websocket::SubProtocolContext::SubProtocolContext	(	core::socket::stream::SocketConnection *	socketConnection,
		bool	role )

Definition at line 28 of file SubProtocolContext.cpp.

        : Receiver(socketConnection)
        , Transmitter(socketConnection, role) {
    }

References web::websocket::Receiver::Receiver(), and web::websocket::Transmitter::Transmitter().

Here is the call graph for this function:

SubProtocolContext() [2/2]

web::websocket::SubProtocolContext::SubProtocolContext ( const SubProtocolContext & )

delete

~SubProtocolContext()

web::websocket::SubProtocolContext::~SubProtocolContext ( )

override

Definition at line 33 of file SubProtocolContext.cpp.

                                            {
    }

Member Function Documentation

getSocketConnection()

virtual core::socket::stream::SocketConnection * web::websocket::SubProtocolContext::getSocketConnection ( )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

operator=()

SubProtocolContext & web::websocket::SubProtocolContext::operator= ( const SubProtocolContext & )

delete

sendClose() [1/2]

virtual void web::websocket::SubProtocolContext::sendClose ( const char * message, std::size_t messageLength )

privatepure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendClose() [2/2]

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

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendMessage()

virtual void web::websocket::SubProtocolContext::sendMessage ( uint8_t opCode, const char * message, std::size_t messageLength )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendMessageEnd()

virtual void web::websocket::SubProtocolContext::sendMessageEnd ( const char * message, std::size_t messageLength )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendMessageFrame()

virtual void web::websocket::SubProtocolContext::sendMessageFrame ( const char * message, std::size_t messageLength )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendMessageStart()

virtual void web::websocket::SubProtocolContext::sendMessageStart ( uint8_t opCode, const char * message, std::size_t messageLength )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendPing()

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

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

sendPong()

virtual void web::websocket::SubProtocolContext::sendPong ( const char * reason = nullptr, std::size_t reasonLength = 0 )

pure virtual

Implemented in web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >, web::websocket::SocketContextUpgrade< SubProtocol, web::http::client::Request, web::http::client::Response >, and web::websocket::SocketContextUpgrade< SubProtocol, web::http::server::Request, web::http::server::Response >.

---

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

• web/websocket/SubProtocolContext.h
• web/websocket/SubProtocolContext.cpp