2018-09-25 09:55:41 +08:00
|
|
|
|
/*
|
2020-04-04 20:30:09 +08:00
|
|
|
|
* Copyright (c) 2016 The ZLMediaKit project authors. All Rights Reserved.
|
2018-09-25 09:55:41 +08:00
|
|
|
|
*
|
|
|
|
|
* This file is part of ZLMediaKit(https://github.com/xiongziliang/ZLMediaKit).
|
|
|
|
|
*
|
2020-04-04 20:30:09 +08:00
|
|
|
|
* Use of this source code is governed by MIT license that can be found in the
|
|
|
|
|
* LICENSE file in the root of the source tree. All contributing project authors
|
|
|
|
|
* may be found in the AUTHORS file in the root of the source tree.
|
2018-09-25 09:55:41 +08:00
|
|
|
|
*/
|
2018-09-21 16:11:09 +08:00
|
|
|
|
|
|
|
|
|
#ifndef ZLMEDIAKIT_WEBSOCKETSPLITTER_H
|
|
|
|
|
#define ZLMEDIAKIT_WEBSOCKETSPLITTER_H
|
|
|
|
|
|
|
|
|
|
#include <cstdint>
|
|
|
|
|
#include <string>
|
|
|
|
|
#include <vector>
|
|
|
|
|
#include <memory>
|
2019-08-13 12:00:21 +08:00
|
|
|
|
#include "Network/Buffer.h"
|
|
|
|
|
using namespace std;
|
|
|
|
|
using namespace toolkit;
|
2018-09-25 09:55:41 +08:00
|
|
|
|
|
2020-08-08 12:17:06 +08:00
|
|
|
|
//websocket组合包最大不得超过4MB(防止内存爆炸)
|
|
|
|
|
#define MAX_WS_PACKET (4 * 1024 * 1024)
|
|
|
|
|
|
2018-10-24 17:17:55 +08:00
|
|
|
|
namespace mediakit {
|
2018-09-25 09:55:41 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
class WebSocketHeader {
|
|
|
|
|
public:
|
|
|
|
|
typedef std::shared_ptr<WebSocketHeader> Ptr;
|
|
|
|
|
typedef enum {
|
|
|
|
|
CONTINUATION = 0x0,
|
|
|
|
|
TEXT = 0x1,
|
|
|
|
|
BINARY = 0x2,
|
|
|
|
|
RSV3 = 0x3,
|
|
|
|
|
RSV4 = 0x4,
|
|
|
|
|
RSV5 = 0x5,
|
|
|
|
|
RSV6 = 0x6,
|
|
|
|
|
RSV7 = 0x7,
|
|
|
|
|
CLOSE = 0x8,
|
|
|
|
|
PING = 0x9,
|
|
|
|
|
PONG = 0xA,
|
|
|
|
|
CONTROL_RSVB = 0xB,
|
|
|
|
|
CONTROL_RSVC = 0xC,
|
|
|
|
|
CONTROL_RSVD = 0xD,
|
|
|
|
|
CONTROL_RSVE = 0xE,
|
|
|
|
|
CONTROL_RSVF = 0xF
|
|
|
|
|
} Type;
|
2018-09-21 18:48:35 +08:00
|
|
|
|
public:
|
2020-08-08 12:17:06 +08:00
|
|
|
|
|
2020-05-25 14:36:07 +08:00
|
|
|
|
WebSocketHeader() : _mask(4){
|
|
|
|
|
//获取_mask内部buffer的内存地址,该内存是malloc开辟的,地址为随机
|
|
|
|
|
uint64_t ptr = (uint64_t)(&_mask[0]);
|
|
|
|
|
//根据内存地址设置掩码随机数
|
|
|
|
|
_mask.assign((uint8_t*)(&ptr), (uint8_t*)(&ptr) + 4);
|
|
|
|
|
}
|
2018-09-21 18:48:35 +08:00
|
|
|
|
virtual ~WebSocketHeader(){}
|
2020-08-08 12:17:06 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
public:
|
|
|
|
|
bool _fin;
|
|
|
|
|
uint8_t _reserved;
|
|
|
|
|
Type _opcode;
|
|
|
|
|
bool _mask_flag;
|
2020-05-25 13:51:00 +08:00
|
|
|
|
uint64_t _payload_len;
|
2018-09-21 16:11:09 +08:00
|
|
|
|
vector<uint8_t > _mask;
|
|
|
|
|
};
|
|
|
|
|
|
2020-08-08 12:17:06 +08:00
|
|
|
|
//websocket协议收到的字符串类型缓存,用户协议层获取该数据传输的方式
|
|
|
|
|
class WebSocketBuffer : public BufferString {
|
|
|
|
|
public:
|
|
|
|
|
typedef std::shared_ptr<WebSocketBuffer> Ptr;
|
|
|
|
|
|
|
|
|
|
template<typename ...ARGS>
|
|
|
|
|
WebSocketBuffer(WebSocketHeader::Type headType, bool fin, ARGS &&...args)
|
|
|
|
|
: _head_type(headType), _fin(fin), BufferString(std::forward<ARGS>(args)...) {}
|
|
|
|
|
|
|
|
|
|
~WebSocketBuffer() override {}
|
|
|
|
|
|
|
|
|
|
WebSocketHeader::Type headType() const { return _head_type; }
|
|
|
|
|
|
|
|
|
|
bool isFinished() const { return _fin; };
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
WebSocketHeader::Type _head_type;
|
|
|
|
|
bool _fin;
|
|
|
|
|
};
|
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
class WebSocketSplitter : public WebSocketHeader{
|
|
|
|
|
public:
|
|
|
|
|
WebSocketSplitter(){}
|
|
|
|
|
virtual ~WebSocketSplitter(){}
|
|
|
|
|
|
2018-09-21 18:48:35 +08:00
|
|
|
|
/**
|
|
|
|
|
* 输入数据以便解包webSocket数据以及处理粘包问题
|
2020-05-25 13:51:00 +08:00
|
|
|
|
* 可能触发onWebSocketDecodeHeader和onWebSocketDecodePayload回调
|
2018-09-21 18:48:35 +08:00
|
|
|
|
* @param data 需要解包的数据,可能是不完整的包或多个包
|
|
|
|
|
* @param len 数据长度
|
|
|
|
|
*/
|
2018-09-21 16:11:09 +08:00
|
|
|
|
void decode(uint8_t *data,uint64_t len);
|
2018-09-21 18:48:35 +08:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 编码一个数据包
|
|
|
|
|
* 将触发2次onWebSocketEncodeData回调
|
2018-09-27 16:03:53 +08:00
|
|
|
|
* @param header 数据头
|
2019-08-13 12:00:21 +08:00
|
|
|
|
* @param buffer 负载数据
|
2018-09-21 18:48:35 +08:00
|
|
|
|
*/
|
2019-08-13 12:00:21 +08:00
|
|
|
|
void encode(const WebSocketHeader &header,const Buffer::Ptr &buffer);
|
2020-08-08 12:17:06 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
protected:
|
2018-09-21 18:48:35 +08:00
|
|
|
|
/**
|
2020-05-25 13:51:00 +08:00
|
|
|
|
* 收到一个webSocket数据包包头,后续将继续触发onWebSocketDecodePayload回调
|
2018-09-27 16:03:53 +08:00
|
|
|
|
* @param header 数据包头
|
2018-09-21 18:48:35 +08:00
|
|
|
|
*/
|
2018-09-27 16:03:53 +08:00
|
|
|
|
virtual void onWebSocketDecodeHeader(const WebSocketHeader &header) {};
|
2018-09-21 18:48:35 +08:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 收到webSocket数据包负载
|
2018-09-27 16:03:53 +08:00
|
|
|
|
* @param header 数据包包头
|
2018-09-21 18:48:35 +08:00
|
|
|
|
* @param ptr 负载数据指针
|
|
|
|
|
* @param len 负载数据长度
|
2020-05-25 13:51:00 +08:00
|
|
|
|
* @param recved 已接收数据长度(包含本次数据长度),等于header._payload_len时则接受完毕
|
2018-09-21 18:48:35 +08:00
|
|
|
|
*/
|
2020-05-25 13:51:00 +08:00
|
|
|
|
virtual void onWebSocketDecodePayload(const WebSocketHeader &header, const uint8_t *ptr, uint64_t len, uint64_t recved) {};
|
2018-09-27 16:03:53 +08:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 接收到完整的一个webSocket数据包后回调
|
|
|
|
|
* @param header 数据包包头
|
|
|
|
|
*/
|
|
|
|
|
virtual void onWebSocketDecodeComplete(const WebSocketHeader &header) {};
|
2018-09-21 18:48:35 +08:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* websocket数据编码回调
|
|
|
|
|
* @param ptr 数据指针
|
|
|
|
|
* @param len 数据指针长度
|
|
|
|
|
*/
|
2020-11-01 03:41:35 +08:00
|
|
|
|
virtual void onWebSocketEncodeData(Buffer::Ptr buffer){};
|
2020-08-08 12:17:06 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
private:
|
2020-05-25 13:51:00 +08:00
|
|
|
|
void onPayloadData(uint8_t *data, uint64_t len);
|
2020-08-08 12:17:06 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
private:
|
|
|
|
|
string _remain_data;
|
|
|
|
|
int _mask_offset = 0;
|
|
|
|
|
bool _got_header = false;
|
2020-05-25 13:51:00 +08:00
|
|
|
|
uint64_t _payload_offset = 0;
|
2018-09-21 16:11:09 +08:00
|
|
|
|
};
|
|
|
|
|
|
2018-10-24 17:17:55 +08:00
|
|
|
|
} /* namespace mediakit */
|
2018-09-25 09:55:41 +08:00
|
|
|
|
|
2018-09-21 16:11:09 +08:00
|
|
|
|
|
|
|
|
|
#endif //ZLMEDIAKIT_WEBSOCKETSPLITTER_H
|