AI automatically translates all comments in the code into English (#3917)

This commit is contained in:
alex
2024-09-19 14:53:50 +08:00
committed by GitHub
parent 046de691cb
commit 4152dcd409
279 changed files with 10602 additions and 3038 deletions

View File

@@ -17,7 +17,8 @@
#include <memory>
#include "Network/Buffer.h"
//websocket组合包最大不得超过4MB(防止内存爆炸)
// websocket组合包最大不得超过4MB(防止内存爆炸) [AUTO-TRANSLATED:99c11a1d]
// websocket combined package size must not exceed 4MB (to prevent memory explosion)
#define MAX_WS_PACKET (4 * 1024 * 1024)
namespace mediakit {
@@ -46,9 +47,11 @@ public:
public:
WebSocketHeader() : _mask(4){
//获取_mask内部buffer的内存地址该内存是malloc开辟的地址为随机
// 获取_mask内部buffer的内存地址该内存是malloc开辟的地址为随机 [AUTO-TRANSLATED:9406f0b6]
// Get the memory address of the internal buffer of _mask, the memory is allocated by malloc, and the address is random
uint64_t ptr = (uint64_t)(&_mask[0]);
//根据内存地址设置掩码随机数
// 根据内存地址设置掩码随机数 [AUTO-TRANSLATED:47881295]
// Set the mask random number according to the memory address
_mask.assign((uint8_t*)(&ptr), (uint8_t*)(&ptr) + 4);
}
@@ -63,7 +66,8 @@ public:
std::vector<uint8_t > _mask;
};
//websocket协议收到的字符串类型缓存用户协议层获取该数据传输的方式
// websocket协议收到的字符串类型缓存用户协议层获取该数据传输的方式 [AUTO-TRANSLATED:a66e0177]
// String type cache received by the websocket protocol, the way the user protocol layer obtains this data transmission
class WebSocketBuffer : public toolkit::BufferString {
public:
using Ptr = std::shared_ptr<WebSocketBuffer>;
@@ -88,6 +92,12 @@ public:
* 可能触发onWebSocketDecodeHeader和onWebSocketDecodePayload回调
* @param data 需要解包的数据,可能是不完整的包或多个包
* @param len 数据长度
* Input data to unpack webSocket data and handle sticky packet problems
* May trigger onWebSocketDecodeHeader and onWebSocketDecodePayload callbacks
* @param data Data to be unpacked, may be incomplete packets or multiple packets
* @param len Data length
* [AUTO-TRANSLATED:e5f2c2c6]
*/
void decode(uint8_t *data, size_t len);
@@ -96,6 +106,12 @@ public:
* 将触发2次onWebSocketEncodeData回调
* @param header 数据头
* @param buffer 负载数据
* Encode a data packet
* Will trigger 2 onWebSocketEncodeData callbacks
* @param header Data header
* @param buffer Payload data
* [AUTO-TRANSLATED:f308e552]
*/
void encode(const WebSocketHeader &header,const toolkit::Buffer::Ptr &buffer);
@@ -103,6 +119,10 @@ protected:
/**
* 收到一个webSocket数据包包头后续将继续触发onWebSocketDecodePayload回调
* @param header 数据包头
* Receive a webSocket data packet header, and will continue to trigger onWebSocketDecodePayload callback
* @param header Data packet header
* [AUTO-TRANSLATED:7bc6b7c6]
*/
virtual void onWebSocketDecodeHeader(const WebSocketHeader &header) {};
@@ -112,12 +132,23 @@ protected:
* @param ptr 负载数据指针
* @param len 负载数据长度
* @param recved 已接收数据长度(包含本次数据长度)等于header._payload_len时则接受完毕
* Receive webSocket data packet payload
* @param header Data packet header
* @param ptr Payload data pointer
* @param len Payload data length
* @param recved Received data length (including the length of this data), equals header._payload_len when the reception is complete
* [AUTO-TRANSLATED:ca056d2e]
*/
virtual void onWebSocketDecodePayload(const WebSocketHeader &header, const uint8_t *ptr, size_t len, size_t recved) {};
/**
* 接收到完整的一个webSocket数据包后回调
* @param header 数据包包头
* Callback after receiving a complete webSocket data packet
* @param header Data packet header
* [AUTO-TRANSLATED:f506a7c5]
*/
virtual void onWebSocketDecodeComplete(const WebSocketHeader &header) {};
@@ -125,6 +156,12 @@ protected:
* websocket数据编码回调
* @param ptr 数据指针
* @param len 数据指针长度
* websocket data encoding callback
* @param ptr Data pointer
* @param len Data pointer length
* [AUTO-TRANSLATED:7c940c67]
*/
virtual void onWebSocketEncodeData(toolkit::Buffer::Ptr buffer){};