#include <Transmitter.h>

Inheritance diagram for web::websocket::Transmitter:

Collaboration diagram for web::websocket::Transmitter:

Public Member Functions
	Transmitter ()=delete

	Transmitter (const Transmitter &)=delete

Transmitter &	operator= (const Transmitter &)=delete

virtual	~Transmitter ()

Protected Member Functions
	Transmitter (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)

std::size_t	getPayloadTotalSent () const

Protected Attributes
bool	closeSent = false

Private Member Functions
void	send (bool end, uint8_t opCode, const char *message, std::size_t messageLength)

void	sendFrame (bool fin, uint8_t opCode, const char *payload, uint64_t payloadLength)

void	sendFrameData (uint8_t data) const

void	sendFrameData (uint16_t data) const

void	sendFrameData (uint32_t data) const

void	sendFrameData (uint64_t data) const

void	sendFrameData (const char *frame, uint64_t frameLength) const

virtual void	sendFrameChunk (const char *data, std::size_t dataLength) const =0

Private Attributes
std::random_device	randomDevice

std::uniform_int_distribution< uint32_t >	distribution {0, UINT32_MAX}

bool	masking = false

std::size_t	payloadTotalSent = 0

Detailed Description

Definition at line 55 of file Transmitter.h.

Constructor & Destructor Documentation

◆ Transmitter() [1/3]

web::websocket::Transmitter::Transmitter ( )

delete

◆ Transmitter() [2/3]

web::websocket::Transmitter::Transmitter ( const Transmitter & )

delete

◆ ~Transmitter()

web::websocket::Transmitter::~Transmitter ( )

virtual

Definition at line 64 of file Transmitter.cpp.

64 {

65 }

◆ Transmitter() [3/3]

web::websocket::Transmitter::Transmitter ( bool masking )

protected

Definition at line 60 of file Transmitter.cpp.

61 : masking(masking) {

62 }

web::websocket::Transmitter::masking

bool masking

Definition Transmitter.h:91

References masking.

Referenced by web::websocket::SubProtocolContext::SubProtocolContext().

Here is the caller graph for this function:

Member Function Documentation

◆ getPayloadTotalSent()

std::size_t web::websocket::Transmitter::getPayloadTotalSent ( ) const

protected

Definition at line 83 of file Transmitter.cpp.

                                                     {
        return payloadTotalSent;
    }

References payloadTotalSent.

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::getPayloadTotalSent().

Here is the caller graph for this function:

◆ operator=()

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

delete

◆ send()

void web::websocket::Transmitter::send	(	bool	end,
		uint8_t	opCode,
		const char *	message,
		std::size_t	messageLength
	)

private

Definition at line 87 of file Transmitter.cpp.

                                                                                                 {
        std::size_t messageOffset = 0;
 
        do {
            const std::size_t sendFrameLength =
                (messageLength - messageOffset <= WSMAXFRAMEPAYLOADLENGTH) ? messageLength - messageOffset : WSMAXFRAMEPAYLOADLENGTH;
 
            const bool fin = (sendFrameLength == messageLength - messageOffset) && end;
 
            sendFrame(fin, opCode, message + messageOffset, sendFrameLength);
 
            messageOffset += sendFrameLength;
 
            opCode = 0; // continuation
        } while (messageLength - messageOffset > 0);
 
        payloadTotalSent += messageLength;
    }

References payloadTotalSent, and sendFrame().

Referenced by sendMessage(), sendMessageEnd(), sendMessageFrame(), and sendMessageStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFrame()

void web::websocket::Transmitter::sendFrame	(	bool	fin,
		uint8_t	opCode,
		const char *	payload,
		uint64_t	payloadLength
	)

private

Definition at line 106 of file Transmitter.cpp.

                                                                                                     {
        uint64_t length = 0;
 
        if (payloadLength < 126) {
            length = payloadLength;
        } else if (payloadLength < 0x10000) {
            length = 126;
        } else {
            length = 127;
        }
 
        char header[2];
        header[0] = static_cast<char>((fin ? 0b10000000 : 0) | opCode);
 
        header[1] = static_cast<char>((masking ? 0b10000000 : 0) | length);
 
        sendFrameData(header, 2);
 
        switch (length) {
            case 126:
                sendFrameData(static_cast<uint16_t>(payloadLength));
                break;
            case 127:
                sendFrameData(payloadLength);
                break;
        }
 
        union MaskingKey {
            uint32_t keyAsValue;
            char keyAsBytes[4];
        };
 
        MaskingKey maskingKeyAsArray = {.keyAsValue = distribution(randomDevice)};
 
        if (payloadLength > 0) {
            LOG(TRACE) << "WebSocket send: Frame data\n" << utils::hexDump(payload, payloadLength, 32, true);
        }
 
        if (masking) {
            sendFrameData(maskingKeyAsArray.keyAsBytes, 4);
 
            for (uint64_t i = 0; i < payloadLength; i++) {
                *(const_cast<char*>(payload) + i) = static_cast<char>(*(payload + i) ^ *(maskingKeyAsArray.keyAsBytes + i % 4));
            }
        }
 
        sendFrameData(payload, payloadLength);
 
        if (masking) {
            for (uint64_t i = 0; i < payloadLength; i++) {
                *(const_cast<char*>(payload) + i) = static_cast<char>(*(payload + i) ^ *(maskingKeyAsArray.keyAsBytes + i % 4));
            }
        }
    }

References distribution, utils::hexDump(), masking, randomDevice, sendFrameData(), sendFrameData(), and sendFrameData().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFrameChunk()

virtual void web::websocket::Transmitter::sendFrameChunk	(	const char *	data,
		std::size_t	dataLength
	)		const

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 >.

Referenced by sendFrameData().

Here is the caller graph for this function:

◆ sendFrameData() [1/5]

void web::websocket::Transmitter::sendFrameData	(	const char *	frame,
		uint64_t	frameLength
	)		const

private

Definition at line 188 of file Transmitter.cpp.

                                                                                 {
        if (!closeSent) {
            uint64_t frameOffset = 0;
 
            do {
                const std::size_t sendChunkLen =
                    (frameLength - frameOffset <= SIZE_MAX) ? static_cast<std::size_t>(frameLength - frameOffset) : SIZE_MAX;
 
                sendFrameChunk(frame + frameOffset, sendChunkLen);
 
                frameOffset += sendChunkLen;
            } while (frameLength - frameOffset > 0);
        }
    }

References closeSent, and sendFrameChunk().

Referenced by sendFrame(), sendFrameData(), sendFrameData(), sendFrameData(), and sendFrameData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFrameData() [2/5]

void web::websocket::Transmitter::sendFrameData ( uint16_t data ) const

private

Definition at line 167 of file Transmitter.cpp.

                                                       {
        if (!closeSent) {
            uint16_t sendData = htobe16(data);
            sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint16_t));
        }
    }

References closeSent, and sendFrameData().

Referenced by sendFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFrameData() [3/5]

void web::websocket::Transmitter::sendFrameData ( uint32_t data ) const

private

Definition at line 174 of file Transmitter.cpp.

                                                       {
        if (!closeSent) {
            uint32_t sendData = htobe32(data);
            sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint32_t));
        }
    }

References closeSent, and sendFrameData().

Here is the call graph for this function:

◆ sendFrameData() [4/5]

void web::websocket::Transmitter::sendFrameData ( uint64_t data ) const

private

Definition at line 181 of file Transmitter.cpp.

                                                       {
        if (!closeSent) {
            uint64_t sendData = htobe64(data);
            sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint64_t));
        }
    }

References closeSent, and sendFrameData().

Referenced by sendFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFrameData() [5/5]

void web::websocket::Transmitter::sendFrameData ( uint8_t data ) const

private

Definition at line 161 of file Transmitter.cpp.

                                                      {
        if (!closeSent) {
            sendFrameData(reinterpret_cast<char*>(&data), sizeof(uint8_t));
        }
    }

References closeSent, and sendFrameData().

Here is the call graph for this function:

◆ sendMessage()

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

protected

Definition at line 67 of file Transmitter.cpp.

                                                                                              {
        send(true, opCode, message, messageLength);
    }

References send().

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::sendMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMessageEnd()

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

protected

Definition at line 79 of file Transmitter.cpp.

                                                                                 {
        send(true, 0, message, messageLength);
    }

References send().

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::sendMessageEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMessageFrame()

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

protected

Definition at line 75 of file Transmitter.cpp.

                                                                                   {
        send(false, 0, message, messageLength);
    }

References send().

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::sendMessageFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMessageStart()

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

protected

Definition at line 71 of file Transmitter.cpp.

                                                                                                   {
        send(false, opCode, message, messageLength);
    }

References send().

Referenced by web::websocket::SocketContextUpgrade< SubProtocolT, RequestT, ResponseT >::sendMessageStart().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ closeSent

bool web::websocket::Transmitter::closeSent = false

protected

Definition at line 94 of file Transmitter.h.

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

◆ distribution

std::uniform_int_distribution<uint32_t> web::websocket::Transmitter::distribution {0, UINT32_MAX}

private

Definition at line 89 of file Transmitter.h.

89{0, UINT32_MAX};

Referenced by sendFrame().

◆ masking

bool web::websocket::Transmitter::masking = false

private

Definition at line 91 of file Transmitter.h.

Referenced by sendFrame(), and Transmitter().

◆ payloadTotalSent

std::size_t web::websocket::Transmitter::payloadTotalSent = 0

private

Definition at line 97 of file Transmitter.h.

Referenced by getPayloadTotalSent(), and send().

◆ randomDevice

std::random_device web::websocket::Transmitter::randomDevice

private

Definition at line 88 of file Transmitter.h.

Referenced by sendFrame().

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

web/websocket/Transmitter.h
web/websocket/Transmitter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Transmitter() [1/3]

◆ Transmitter() [2/3]

◆ ~Transmitter()

◆ Transmitter() [3/3]

Member Function Documentation

◆ getPayloadTotalSent()

◆ operator=()

◆ send()

◆ sendFrame()

◆ sendFrameChunk()

◆ sendFrameData() [1/5]

◆ sendFrameData() [2/5]

◆ sendFrameData() [3/5]

◆ sendFrameData() [4/5]

◆ sendFrameData() [5/5]

◆ sendMessage()

◆ sendMessageEnd()

◆ sendMessageFrame()

◆ sendMessageStart()

Member Data Documentation

◆ closeSent

◆ distribution

◆ masking

◆ payloadTotalSent

◆ randomDevice