Tcp服务端类更多...

#include <sttnet.h>

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

Public 成员函数
	TcpServer (const int &maxFD=10000, const bool &security_open=true, const int &connectionNumLimit=20, const int &connectionRateLimit=6, const int &buffer_size=8, const int &requestRate=12, const int &checkFrequency=1, const int &connectionTimeout=1800)
	构造函数，默认是启用安全模块。限制一个ip最大连接为20；同一个ip每秒最快连接速度为6 更多...

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证书等更多...

bool	setFunction (std::function< bool(TcpFDHandler &k, TcpFDInf &inf)> fc)
	设置收到客户端消息后的回调函数注册一个回调函数更多...

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

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

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

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

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

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

Protected 成员函数
bool	allowRequest (const int &cclientfd)

void	connectionDetect ()

Protected 属性
unsigned long	buffer_size

int	maxFD

security::ConnectionLimiter	connectionLimiter

TcpFDInf *	clientfd

int	flag1 =true

std::queue< QueueFD > *	fdQueue

std::mutex *	lq1

std::condition_variable *	cv

int	consumerNum

std::mutex	lco1

bool	unblock

SSL_CTX *	ctx =nullptr

bool	TLS =false

int	requestRate

int	checkFrequency

int	connectionTimeout

bool	security_open

详细描述

Tcp服务端类

注解: 默认底层实现是epoll边缘触发+套接字非阻塞模式

构造及析构函数说明

stt::network::TcpServer::TcpServer	(	const int &	maxFD = `10000`,
		const bool &	security_open = `true`,
		const int &	connectionNumLimit = `20`,
		const int &	connectionRateLimit = `6`,
		const int &	buffer_size = `8`,
		const int &	requestRate = `12`,
		const int &	checkFrequency = `1`,
		const int &	connectionTimeout = `1800`
	)

inline

构造函数，默认是启用安全模块。限制一个ip最大连接为20；同一个ip每秒最快连接速度为6

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

参数

maxFD	服务对象的最大接受连接数默认为10000
security_open	true:开启安全模块 false：关闭安全模块（默认为开启）
connectionNumLimit	同一个ip连接数目的上限
connectionRateLimit	同一个ip每秒钟连接数目的上限
buffer_size	同一个连接允许传输的最大数据量（单位为kb）默认为8kb
requestRatte	同一个连接一秒内允许的最大请求数量（默认为12次）
checkFrequency	检查僵尸连接的频率（单位分钟）默认为1分钟 -1为不做检查
connectionTimeout	连接多少秒内没有任何反应就视为僵尸连接（单位为秒）默认60秒 -1为无限制

stt::network::TcpServer::~TcpServer ( )

inline

TcpServer 类的析构函数

注解: 会调用close函数关闭

成员函数说明

bool stt::network::TcpServer::allowRequest ( const int & cclientfd )

protected

bool stt::network::TcpServer::close ( )

关闭监听和所有已连接的套接字

注解: 关闭监听和所有已经连接的套接字，已经注册的回调函数和tls不会删除和redraw; 会阻塞等待直到全部关闭完成

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

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

关闭某个套接字的连接

参数

fd 需要关闭的套接字

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

void stt::network::TcpServer::connectionDetect ( )

protected

SSL* stt::network::TcpServer::getSSL ( const int & fd )

查询和服务端的连接，传入套接字，返回加密的SSL句柄

返回: 返回加密的SSL指针；如果不存在此fd或者没有加密返回nullptr

bool stt::network::TcpServer::isListen ( )

inline

返回对象的监听状态

返回: true:正在监听 false：没有在监听

void stt::network::TcpServer::redrawTLS ( )

撤销TLS加密，ca证书等

bool stt::network::TcpServer::setFunction ( std::function< bool(TcpFDHandler &k, TcpFDInf &inf)> fc )

inline

设置收到客户端消息后的回调函数注册一个回调函数

参数

fc	一个函数或函数对象，用于收到客户端消息后处理逻辑 -参数：TcpFDHandler &k - 和客户端连接的套接字的引用 TcpFDInf &inf - 客户端信息，还有处理进度，状态机信息等 -返回： bool - 返回true处理成功，返回false处理失败

注解: 传入的函数应该有如下签名 bool func(TcpFDHandler &k); 如果处理失败了会关闭Tcp连接

bool stt::network::TcpServer::setTLS	(	const char *	cert,
		const char *	key,
		const char *	passwd,
		const char *	ca
	)

启用 TLS 加密并配置服务器端证书与密钥

本函数用于初始化 OpenSSL，并为 TCP 服务器启用 TLS（SSL/TLSv1 协议族）支持。它加载服务器端证书、私钥和可选的 CA 根证书，用于实现对等验证。

若已启用 TLS，将自动重建（重载）上下文。

参数

cacert	服务器端证书链文件路径（通常为 PEM 格式，包括中间证书）
key	私钥文件路径（与证书匹配的 PEM 格式密钥）
passwd	私钥文件的密码（若密钥加密，可为空字符串）
ca	CA 根证书路径，用于验证客户端证书（PEM 格式）

注解

使用的协议方法为 SSLv23_method()，实际上支持 SSLv3/TLSv1/TLSv1.1/TLSv1.2 及更高版本（具体取决于 OpenSSL 版本与配置）

校验证书策略使用 SSL_VERIFY_FAIL_IF_NO_PEER_CERT，即：

若客户端未提供证书，则握手失败（更安全，推荐）
若证书无效或校验失败，也会终止握手

返回: true 启用 TLS 成功，服务器已进入加密状态; false 启用失败（日志将输出具体错误）

警告: 启用 TLS 后，所有接入连接必须遵循 TLS 握手流程，否则通信失败

参见: redrawTLS() 若已有 TLS 上下文存在，会先释放并重建（可用于热更新证书）

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

打开Tcp服务器监听程序

参数

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

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

bool stt::network::TcpServer::stopListen ( )

停止监听

警告: 仅停止监听(但是套接字也已经无法接收了，它依赖于监听和消费者，所以这个函数没什么意义)

返回: true:停止成功 false：停止失败

类成员变量说明

unsigned long stt::network::TcpServer::buffer_size

protected

int stt::network::TcpServer::checkFrequency

protected

TcpFDInf* stt::network::TcpServer::clientfd

protected

security::ConnectionLimiter stt::network::TcpServer::connectionLimiter

protected

int stt::network::TcpServer::connectionTimeout

protected

int stt::network::TcpServer::consumerNum

protected

SSL_CTX* stt::network::TcpServer::ctx =nullptr

protected

std::condition_variable* stt::network::TcpServer::cv

protected

std::queue<QueueFD>* stt::network::TcpServer::fdQueue

protected

int stt::network::TcpServer::flag1 =true

protected

std::mutex stt::network::TcpServer::lco1

protected

std::mutex* stt::network::TcpServer::lq1

protected

int stt::network::TcpServer::maxFD

protected

int stt::network::TcpServer::requestRate

protected

bool stt::network::TcpServer::security_open

protected

bool stt::network::TcpServer::TLS =false

protected

bool stt::network::TcpServer::unblock

protected

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

include/sttnet.h

Public 成员函数

Protected 成员函数

Protected 属性

详细描述

构造及析构函数说明

成员函数说明

类成员变量说明