SNode.C
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
web::websocket::Transmitter Class Reference

#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 (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)
 

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
 

Private Attributes

std::random_device randomDevice
 
std::uniform_int_distribution< uint32_t > distribution {0, UINT32_MAX}
 
core::socket::stream::SocketConnection * socketConnection = nullptr
 
bool masking = false
 

Detailed Description

Definition at line 39 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 43 of file Transmitter.cpp.

43 {
44 }

◆ Transmitter() [3/3]

web::websocket::Transmitter::Transmitter ( core::socket::stream::SocketConnection * socketConnection,
bool masking )
protected

Definition at line 38 of file Transmitter.cpp.

39 : socketConnection(socketConnection)
40 , masking(masking) {
41 }
web::websocket::Transmitter::socketConnection
core::socket::stream::SocketConnection * socketConnection
Definition Transmitter.h:71

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

Here is the caller graph for this function:

Member Function Documentation

◆ 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 62 of file Transmitter.cpp.

62 {
63 std::size_t messageOffset = 0;
64
65 do {
66 const std::size_t sendFrameLength =
67 (messageLength - messageOffset <= WSMAXFRAMEPAYLOADLENGTH) ? messageLength - messageOffset : WSMAXFRAMEPAYLOADLENGTH;
68
69 const bool fin = (sendFrameLength == messageLength - messageOffset) && end;
70
71 sendFrame(fin, opCode, message + messageOffset, sendFrameLength);
72
73 messageOffset += sendFrameLength;
74
75 opCode = 0; // continuation
76 } while (messageLength - messageOffset > 0);
77 }
WSMAXFRAMEPAYLOADLENGTH
constexpr int WSMAXFRAMEPAYLOADLENGTH
Definition Transmitter.cpp:34
web::websocket::Transmitter::sendFrame
void sendFrame(bool fin, uint8_t opCode, const char *payload, uint64_t payloadLength)
Definition Transmitter.cpp:79

◆ sendFrame()

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

Definition at line 79 of file Transmitter.cpp.

79 {
80 uint64_t length = 0;
81
82 if (payloadLength < 126) {
83 length = payloadLength;
84 } else if (payloadLength < 0x10000) {
85 length = 126;
86 } else {
87 length = 127;
88 }
89
90 char header[2];
91 header[0] = static_cast<char>((fin ? 0b10000000 : 0) | opCode);
92
93 header[1] = static_cast<char>((masking ? 0b10000000 : 0) | length);
94
95 sendFrameData(header, 2);
96
97 switch (length) {
98 case 126:
99 sendFrameData(static_cast<uint16_t>(payloadLength));
100 break;
101 case 127:
102 sendFrameData(payloadLength);
103 break;
104 }
105
106 union MaskingKey {
107 uint32_t keyAsValue;
108 char keyAsBytes[4];
109 };
110
111 MaskingKey maskingKeyAsArray = {.keyAsValue = distribution(randomDevice)};
112
113 if (payloadLength > 0) {
114 LOG(TRACE) << "WebSocket send: Frame data\n" << utils::hexDump(payload, payloadLength, 32, true);
115 }
116
117 if (masking) {
118 sendFrameData(htobe32(maskingKeyAsArray.keyAsValue));
119
120 for (uint64_t i = 0; i < payloadLength; i++) {
121 *(const_cast<char*>(payload) + i) = static_cast<char>(*(payload + i) ^ *(maskingKeyAsArray.keyAsBytes + i % 4));
122 }
123 }
124
125 sendFrameData(payload, payloadLength);
126
127 if (masking) {
128 for (uint64_t i = 0; i < payloadLength; i++) {
129 *(const_cast<char*>(payload) + i) = static_cast<char>(*(payload + i) ^ *(maskingKeyAsArray.keyAsBytes + i % 4));
130 }
131 }
132 }
web::websocket::Transmitter::randomDevice
std::random_device randomDevice
Definition Transmitter.h:68
web::websocket::Transmitter::sendFrameData
void sendFrameData(uint8_t data) const
Definition Transmitter.cpp:134
web::websocket::Transmitter::distribution
std::uniform_int_distribution< uint32_t > distribution
Definition Transmitter.h:69
utils::hexDump
std::string hexDump(const std::vector< char > &bytes, int prefixLength, bool prefixAtFirstLine)
Definition hexdump.cpp:36

◆ sendFrameData() [1/5]

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

Definition at line 161 of file Transmitter.cpp.

161 {
162 if (!closeSent) {
163 uint64_t frameOffset = 0;
164
165 do {
166 std::size_t sendChunkLen =
167 (frameLength - frameOffset <= SIZE_MAX) ? static_cast<std::size_t>(frameLength - frameOffset) : SIZE_MAX;
168
169 socketConnection->sendToPeer(frame + frameOffset, sendChunkLen);
170
171 frameOffset += sendChunkLen;
172 } while (frameLength - frameOffset > 0);
173 }
174 }
core::socket::stream::SocketConnection::sendToPeer
virtual void sendToPeer(const char *chunk, std::size_t chunkLen)=0

◆ sendFrameData() [2/5]

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

Definition at line 140 of file Transmitter.cpp.

140 {
141 if (!closeSent) {
142 uint16_t sendData = htobe16(data);
143 sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint16_t));
144 }
145 }

◆ sendFrameData() [3/5]

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

Definition at line 147 of file Transmitter.cpp.

147 {
148 if (!closeSent) {
149 uint32_t sendData = htobe32(data);
150 sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint32_t));
151 }
152 }

◆ sendFrameData() [4/5]

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

Definition at line 154 of file Transmitter.cpp.

154 {
155 if (!closeSent) {
156 uint64_t sendData = htobe64(data);
157 sendFrameData(reinterpret_cast<char*>(&sendData), sizeof(uint64_t));
158 }
159 }

◆ sendFrameData() [5/5]

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

Definition at line 134 of file Transmitter.cpp.

134 {
135 if (!closeSent) {
136 sendFrameData(reinterpret_cast<char*>(&data), sizeof(uint8_t));
137 }
138 }

◆ sendMessage()

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

Definition at line 46 of file Transmitter.cpp.

46 {
47 send(true, opCode, message, messageLength);
48 }
web::websocket::Transmitter::send
void send(bool end, uint8_t opCode, const char *message, std::size_t messageLength)
Definition Transmitter.cpp:62

◆ sendMessageEnd()

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

Definition at line 58 of file Transmitter.cpp.

58 {
59 send(true, 0, message, messageLength);
60 }

◆ sendMessageFrame()

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

Definition at line 54 of file Transmitter.cpp.

54 {
55 send(false, 0, message, messageLength);
56 }

◆ sendMessageStart()

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

Definition at line 50 of file Transmitter.cpp.

50 {
51 send(false, opCode, message, messageLength);
52 }

Member Data Documentation

◆ closeSent

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

Definition at line 76 of file Transmitter.h.

◆ distribution

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

Definition at line 69 of file Transmitter.h.

69{0, UINT32_MAX};

◆ masking

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

Definition at line 73 of file Transmitter.h.

◆ randomDevice

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

Definition at line 68 of file Transmitter.h.

◆ socketConnection

core::socket::stream::SocketConnection* web::websocket::Transmitter::socketConnection = nullptr
private

Definition at line 71 of file Transmitter.h.

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