WebSocketServer服务端操作类更多...

#include <sttnet.h>

类 stt::network::WebSocketServer 继承关系图:

Public 成员函数
void	putTask (const std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> &fun, WebSocketServerFDHandler &k, WebSocketFDInformation &inf)
	把一个任务放入工作线程池由工作线程完成更多...

	WebSocketServer (const unsigned long long &maxFD=1000000, const int &buffer_size=256, const bool &security_open=true, const int &connectionNumLimit=5, const int &connectionSecs=10, const int &connectionTimes=3, const int &requestSecs=1, const int &requestTimes=10, const int &checkFrequency=60, const int &connectionTimeout=120)
	构造函数，默认是允许最大1000000个连接，每个连接接收缓冲区最大为256kb，启用安全模块。更多...

void	setSecuritySendBackFun (std::function< void(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fc)
	设置违反信息安全策略时候的返回函数更多...

void	setGlobalSolveFunction (std::function< bool(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fc)
	设置全局备用函数更多...

void	setStartFunction (std::function< bool(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fccc)
	设置websocket连接成功后就执行的回调函数注册一个回调函数更多...

void	setJudgeFunction (std::function< bool(WebSocketFDInformation &k)> fcc)
	设置websocket握手阶段的检查函数，只有检查通过才执行后续握手注册一个回调函数更多...

void	setFunction (const std::string &key, std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fc)
	设置key对应的收到客户端消息后的回调函数更多...

void	setGetKeyFunction (std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> parseKeyFun)
	设置解析出key的回调函数更多...

void	setTimeOutTime (const int &seca)
	设置心跳时间更多...

void	setHBTimeOutTime (const int &secb)
	设置发送心跳后的等待时间更多...

bool	closeFD (const int &fd, const std::string &closeCodeAndMessage)
	发送关闭帧关闭对应套接字的 WebSocket 连接（简化方式）更多...

bool	closeFD (const int &fd, const short &code=1000, const std::string &message="bye")
	发送关闭帧关闭对应套接字的 WebSocket 连接（标准方式）更多...

bool	sendMessage (const int &fd, const std::string &msg, const std::string &type="0001")
	发送 WebSocket 消息给某一个客户端更多...

bool	close ()
	关闭监听和所有连接更多...

bool	close (const int &fd)
	关闭某个套接字的连接 @ 更多...

bool	startListen (const int &port, const int &threads=8)
	打开Websocket服务器监听程序更多...

void	sendMessage (const std::string &msg, const std::string &type="0001")
	广播发送 WebSocket 消息更多...

	~WebSocketServer ()
	WebSocketServer的析构函数更多...

Public 成员函数继承自 stt::network::TcpServer
void	putTask (const std::function< int(TcpFDHandler &k, TcpInformation &inf)> &fun, TcpFDHandler &k, TcpInformation &inf)
	把一个任务放入工作线程池由工作线程完成更多...

	TcpServer (const unsigned long long &maxFD=1000000, const int &buffer_size=256, const bool &security_open=true, const int &connectionNumLimit=20, const int &connectionSecs=1, const int &connectionTimes=6, const int &requestSecs=1, const int &requestTimes=40, const int &checkFrequency=60, const int &connectionTimeout=60)
	构造函数，默认是允许最大1000000个连接，每个连接接收缓冲区最大为256kb，启用安全模块。更多...

bool	startListen (const int &port, const int &threads=8)
	打开Tcp服务器监听程序更多...

bool	setTLS (const char cert, const char key, const char passwd, const char ca)
	启用 TLS 加密并配置服务器端证书与密钥更多...

void	redrawTLS ()
	撤销TLS加密，ca证书等更多...

void	setSecuritySendBackFun (std::function< void(TcpFDHandler &k, TcpInformation &inf)> fc)
	设置违反信息安全策略时候的返回函数更多...

void	setGlobalSolveFunction (std::function< bool(TcpFDHandler &k, TcpInformation &inf)> fc)
	设置全局备用函数更多...

void	setFunction (const std::string &key, std::function< int(TcpFDHandler &k, TcpInformation &inf)> fc)
	设置key对应的收到客户端消息后的回调函数更多...

void	setGetKeyFunction (std::function< int(TcpFDHandler &k, TcpInformation &inf)> parseKeyFun)
	设置解析出key的回调函数更多...

bool	stopListen ()
	停止监听更多...

bool	close ()
	关闭监听和所有已连接的套接字更多...

void	setConnectStrategy (const stt::security::RateLimitType &type)
	设置“连接速率限流”所使用的策略。更多...

void	setRequestStrategy (const stt::security::RateLimitType &type)
	设置“IP 级请求限流”所使用的策略。更多...

void	setPathStrategy (const stt::security::RateLimitType &type)
	设置“path 级请求限流”所使用的策略。更多...

void	setPathLimit (const std::string &path, const int &times, const int &secs)
	设置某个路径的额外限流规则（path 级）。更多...

void	setCloseFun (std::function< void(const int &fd)> closeFun)
	设置关闭tcp连接之后调用的函数更多...

bool	isListen ()
	返回对象的监听状态更多...

SSL *	getSSL (const int &fd)
	查询和服务端的连接，传入套接字，返回加密的SSL句柄更多...

	~TcpServer ()
	TcpServer 类的析构函数更多...

额外继承的成员函数
Protected 属性继承自 stt::network::TcpServer
std::queue< WorkerMessage >	finishQueue

stt::system::WorkerPool *	workpool

unsigned long	buffer_size

unsigned long long	maxFD

security::ConnectionLimiter	connectionLimiter

TcpFDInf *	clientfd

int	flag1 =true

bool	unblock

SSL_CTX *	ctx =nullptr

bool	TLS =false

bool	security_open

int	workerEventFD

int	serverType

int	connectionSecs

int	connectionTimes

int	requestSecs

int	requestTimes

int	checkFrequency

详细描述

WebSocketServer服务端操作类

构造及析构函数说明

stt::network::WebSocketServer::WebSocketServer	(	const unsigned long long &	maxFD = `1000000`,
		const int &	buffer_size = `256`,
		const bool &	security_open = `true`,
		const int &	connectionNumLimit = `5`,
		const int &	connectionSecs = `10`,
		const int &	connectionTimes = `3`,
		const int &	requestSecs = `1`,
		const int &	requestTimes = `10`,
		const int &	checkFrequency = `60`,
		const int &	connectionTimeout = `120`
	)

inline

构造函数，默认是允许最大1000000个连接，每个连接接收缓冲区最大为256kb，启用安全模块。

注解: 打开安全模块会对性能有影响

参数

maxFD	服务对象的最大接受连接数默认为1000000
buffer_size	同一个连接允许传输的最大数据量（单位为kb）默认为256kb
security_open	true:开启安全模块 false：关闭安全模块（默认为开启）
connectionNumLimit	同一个ip连接数目的上限（默认5）
connectionSecs	连接速率统计窗口长度（单位：秒）（默认10秒）
connectionTimes	在 connectionSecs 秒内允许的最大连接次数（默认3次）
requestSecs	请求速率统计窗口长度（单位：秒）（默认1秒）
requestTimes	在秒requestSecs内允许的最大请求数量（默认10次）
checkFrequency	检查僵尸连接的频率（单位：秒） -1为不做检查（默认为60秒）
connectionTimeout	连接多少秒内没有任何反应就视为僵尸连接（单位为秒） -1为无限制（默认120秒）

stt::network::WebSocketServer::~WebSocketServer ( )

inline

WebSocketServer的析构函数

注解: 销毁对象的时候会阻塞直到全部连接和监听等全部关闭

成员函数说明

bool stt::network::WebSocketServer::close ( )

关闭监听和所有连接

注解: 会阻塞直到全部关闭

bool stt::network::WebSocketServer::close ( const int & fd )

virtual

关闭某个套接字的连接 @

注解: 多态了TcpServer的close某个套接字

重载 stt::network::TcpServer .

bool stt::network::WebSocketServer::closeFD	(	const int &	fd,
		const std::string &	closeCodeAndMessage
	)

发送关闭帧关闭对应套接字的 WebSocket 连接（简化方式）

传入套接字fd然后关闭连接直接传入编码后的关闭 payload，其中前两字节为关闭码（big-endian），后续为 UTF-8 编码的关闭原因描述，用于简化调用。

参数

fd	套接字fd
closeCodeAndMessage	编码后的关闭帧 payload（2 字节关闭码 + 可选消息）

返回: true：关闭成功 false：关闭失败

bool stt::network::WebSocketServer::closeFD	(	const int &	fd,
		const short &	code = `1000`,
		const std::string &	message = `"bye"`
	)

发送关闭帧关闭对应套接字的 WebSocket 连接（标准方式）

传入套接字fd然后关闭连接构建符合 RFC 6455 的关闭帧（opcode = 0x8），帧 payload 包含关闭码（2 字节）与可选关闭原因字符串。

参数

fd	套接字fd
code	WebSocket 关闭码，常见包括： 1000：正常关闭（Normal Closure） 1001：终端离开（Going Away） 1002：协议错误（Protocol Error） 1003：不支持的数据类型（Unsupported Data） 1006：非正常关闭（无关闭帧，程序内部使用） 1008：策略违规（Policy Violation） 1011：服务器内部错误（Internal Error）
message	可选关闭原因，供调试或日志记录用

返回: true：关闭成功 false：关闭失败

void stt::network::WebSocketServer::putTask	(	const std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> &	fun,
		WebSocketServerFDHandler &	k,
		WebSocketFDInformation &	inf
	)

把一个任务放入工作线程池由工作线程完成

注解: 应当把速度慢、会阻塞的io任务放入工作线程池

警告: 可执行对象必须严格按照规定的返回值返回

参数

fun	放入工作线程池的可执行对象 -参数：WebSocketServerFDHandler &k - 和客户端连接的套接字的操作对象的引用 WebSocketFDInformation &inf - 客户端信息，保存数据，处理进度，状态机信息等 -返回值：-2:处理失败并且需要关闭连接 -1:处理失败但不需要关闭连接 1:处理成功
k	和客户端连接的套接字的操作对象的引用
inf	客户端信息的引用，保存数据，处理进度，状态机信息等

bool stt::network::WebSocketServer::sendMessage	(	const int &	fd,
		const std::string &	msg,
		const std::string &	type = `"0001"`
	)

inline

发送 WebSocket 消息给某一个客户端

根据 WebSocket 协议，封装并发送一条带掩码的数据帧（客户端必须使用掩码），支持根据 payload 长度自动选择帧格式：

payload <= 125 字节：使用 1 字节长度
126 <= payload <= 65535：使用 2 字节扩展长度（附加 126 标记）
payload > 65535：使用 8 字节扩展长度（附加 127 标记）

参数

fd	和客户端连接的套接字
msg	要发送的消息内容（已编码为文本或二进制）
type	指定消息类型的自定义字段（通常是 WebSocket 帧的 opcode）约定格式为 `"1000" + type`，其中： "0001" 表示文本帧（Text Frame） "0010" 表示二进制帧（Binary Frame） "1000" 表示连接关闭（Close Frame） "1001" 表示 Ping 帧 "1010" 表示 Pong 帧请根据内部约定使用，默认使用 text（文本帧）

返回: true 发送成功; false 发送失败（可能因连接未建立或发送异常）

void stt::network::WebSocketServer::sendMessage	(	const std::string &	msg,
		const std::string &	type = `"0001"`
	)

广播发送 WebSocket 消息

给全体客户端广播发送消息根据 WebSocket 协议，封装并发送一条带掩码的数据帧（客户端必须使用掩码），支持根据 payload 长度自动选择帧格式：

payload <= 125 字节：使用 1 字节长度
126 <= payload <= 65535：使用 2 字节扩展长度（附加 126 标记）
payload > 65535：使用 8 字节扩展长度（附加 127 标记）

参数

msg	要发送的消息内容（已编码为文本或二进制）
type	指定消息类型的自定义字段（通常是 WebSocket 帧的 opcode）约定格式为 `"1000" + type`，其中： "0001" 表示文本帧（Text Frame） "0010" 表示二进制帧（Binary Frame） "1000" 表示连接关闭（Close Frame） "1001" 表示 Ping 帧 "1010" 表示 Pong 帧请根据内部约定使用，默认使用 text（文本帧）

void stt::network::WebSocketServer::setFunction	(	const std::string &	key,
		std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)>	fc
	)

inline

设置key对应的收到客户端消息后的回调函数

注解: 可以设置多个，框架会根据设置顺序依次执行回调函数；也可以设置扔入工作线程池处理的流程，注意设置不同的返回值即可。

警告: 可执行对象必须严格按照规定的返回值返回

参数

key 找到对应回调函数的key

fc

一个函数或函数对象，用于收到客户端消息后处理逻辑 -参数：WebSocketServerFDHandler &k - 和客户端连接的套接字的操作对象的引用 WebSocketFDInformation &inf - 客户端信息，保存数据，处理进度，状态机信息等 -返回值：-2:处理失败并且需要关闭连接 -1:处理失败但不需要关闭连接 0:处理流程已经扔入工作线程池，需要等待处理完成 1:处理成功

s->setFunction("ping",[](WebSocketServerFDHandler &k,WebSocketFDInformation &inf)->int
         {
             k.sendMessage("pong");
             return 1;
         });

void stt::network::WebSocketServer::setGetKeyFunction ( std::function< int(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> parseKeyFun )

inline

设置解析出key的回调函数

注解: 根据传入的参数把key存入TcpInformation信息中的ctx哈希表。框架会根据key的值找到你注册的处理函数。

警告: 可执行对象必须严格按照规定的返回值返回

参数

parseKeyFun

解析key的回调函数 -参数：WebSocketServerFDHandler &k - 和客户端连接的套接字的操作对象的引用 WebSocketFDInformation &inf - 客户端信息，保存数据，处理进度，状态机信息等 -返回值：-2:处理失败并且需要关闭连接 -1:处理失败但不需要关闭连接 0:处理流程已经扔入工作线程池，需要等待处理完成 1:处理成功

s->setGetKeyFunction([](WebSocketServerFDHandler &k,WebSocketFDInformation &inf)->int
         {
             inf.ctx["key"]=inf.message;
             return 1;
         });

void stt::network::WebSocketServer::setGlobalSolveFunction ( std::function< bool(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fc )

inline

设置全局备用函数

注解: 找不到对应回调函数的时候会调用全局备用函数

参数

key	找到对应回调函数的key
fc	一个函数或函数对象，用于收到客户端消息后处理逻辑 -参数：WebSocketServerFDHandler &k - 和客户端连接的套接字的操作对象的引用 WebSocketFDInformation &inf - 客户端信息，保存数据，处理进度，状态机信息等 -返回值：true：处理成功 false：处理失败会关闭连接

void stt::network::WebSocketServer::setHBTimeOutTime ( const int & secb )

inline

设置发送心跳后的等待时间

参数

secb	发送心跳后的等待时间单位为秒不设置默认为30秒

注解: 如果超过这个时间对端没有反应关闭连接

void stt::network::WebSocketServer::setJudgeFunction ( std::function< bool(WebSocketFDInformation &k)> fcc )

inline

设置websocket握手阶段的检查函数，只有检查通过才执行后续握手注册一个回调函数

参数

fc	一个函数或函数对象，websocket连接成功后就执行 -参数：const WebSocketFDInformation &inf - Websocket服务端的信息 -返回值： true：检查通过 false：检查不通过

注解: 传入的函数应该有如下签名 bool func(const WebSocketFDInformation &k); 只有检查通过才执行后续握手，否则断开连接

void stt::network::WebSocketServer::setSecuritySendBackFun ( std::function< void(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fc )

inline

设置违反信息安全策略时候的返回函数

注解: 违反信息安全策略时候的返回函数,调用完就关闭连接

参数

key	找到对应回调函数的key
fc	一个函数或函数对象，用于收到客户端消息后处理逻辑 -参数：WebSocketServerFDHandler &k - 和客户端连接的套接字的操作对象的引用 WebSocketFDInformation &inf - 客户端信息，保存数据，处理进度，状态机信息等 -返回值：true：处理成功 false：处理失败会关闭连接

void stt::network::WebSocketServer::setStartFunction ( std::function< bool(WebSocketServerFDHandler &k, WebSocketFDInformation &inf)> fccc )

inline

设置websocket连接成功后就执行的回调函数注册一个回调函数

参数

fc	一个函数或函数对象，websocket连接成功后就执行 -参数：const WebSocketFDInformation &inf - Websocket服务端的信息 WebSocketServer &k - 服务端对象的引用

注解: 传入的函数应该有如下签名 void func(const WebSocketFDInformation &inf,WebSocketServer &k)

void stt::network::WebSocketServer::setTimeOutTime ( const int & seca )

inline

设置心跳时间

参数

seca	心跳时间单位为分钟。不设置默认为20分钟

bool stt::network::WebSocketServer::startListen	(	const int &	port,
		const int &	threads = `8`
	)

inline

打开Websocket服务器监听程序

参数

port	监听的端口
threads	消费者线程的数量（默认为8）

返回: true：打开监听程序成功 false：打开监听程序失败

该类的文档由以下文件生成:

include/sttnet.h

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

成员函数说明