创建TCP服务端 - TcpServerCreate
函数简介
创建TCP服务端(基于回调的事件驱动模式)。
接口名称
TcpServerCreate
DLL调用
int64_t TcpServerCreate(int64_t instance, const char* bind_addr, int32_t port, TcpServerCallback callback, int64_t user_data, int32_t enable_packet_protocol);
参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| instance | 长整数型 | OLAPlug对象的指针,由 CreateCOLAPlugInterFace 接口生成。 |
| bind_addr | 字符串 | 绑定地址,空或"0.0.0.0"表示所有接口 |
| port | 整数型 | 端口号 |
| callback | TcpServerCallback | 事件回调函数 |
| user_data | 长整数型 | 用户自定义数据,会在回调时传回 |
| enable_packet_protocol | 整数型 | 是否启用消息分包协议:1=启用(推荐),0=禁用(原始模式) |
回调函数类型定义
void TcpServerCallback(int64_t server_handle, int64_t conn_id, int32_t event_type, int64_t data, int32_t data_len, int64_t user_data);
| 参数名 | 类型 | 说明 |
|---|---|---|
| server_handle | 长整数型 | 服务端句柄 |
| conn_id | 长整数型 | 连接ID(用于标识不同的客户端连接) |
| event_type | 整数型 | 事件类型(详见下方事件类型表) |
| data | 长整数型 | 数据指针(仅当 event_type=1 时有效) |
| data_len | 整数型 | 数据长度(仅当 event_type=1 时有效) |
| user_data | 长整数型 | 用户自定义数据,由创建服务端时传入 |
事件类型说明
| event_type | 事件名称 | 说明 |
|---|---|---|
| 0 | 新连接 | 有新客户端连接到服务器(conn_id为新连接的ID) |
| 1 | 接收数据 | 从客户端接收到数据(data指向数据,data_len为长度) |
| 2 | 连接断开 | 客户端断开连接(conn_id为断开的连接ID) |
| 3 | 发送完成 | 数据发送完成 |
示例
// 回调函数
void OnTcpServerEvent(int64_t server_handle, int64_t conn_id, int32_t event_type,
int64_t data, int32_t data_len, int64_t user_data) {
switch (event_type) {
case 0: // 新连接
printf("新连接:conn_id=%lld\n", conn_id);
break;
case 1: // 接收到数据
printf("收到数据[conn_id=%lld]:%.*s\n", conn_id, data_len, (char*)data);
break;
case 2: // 连接断开
printf("连接断开:conn_id=%lld\n", conn_id);
break;
case 3: // 发送完成
printf("发送完成[conn_id=%lld]\n", conn_id);
break;
}
}
// 创建服务端(监听所有接口,端口8080)
int64_t server = TcpServerCreate(instance, "0.0.0.0", 8080, OnTcpServerEvent, 0, 1);
if (server != 0) {
printf("服务端启动成功,监听端口:8080\n");
}
返回值
长整数型,返回服务端句柄,失败返回0。
注意事项
- 消息分包协议(enable_packet_protocol=1):格式为[4字节长度前缀(小端序)][消息体],自动解决TCP粘包问题,推荐用于自定义协议通信
- 原始模式(enable_packet_protocol=0):不添加任何协议头,可能出现粘包问题,适用于与第三方系统通信
- 回调函数在独立线程中执行,注意线程安全
- 使用完毕后需要调用
TcpServerDestroy释放资源 - 端口被占用时创建会失败
