1 /* 2 * Copyright (c) 2016 The ZLMediaKit project authors. All Rights Reserved. 3 * 4 * This file is part of ZLMediaKit(https://github.com/xia-chu/ZLMediaKit). 5 * 6 * Use of this source code is governed by MIT license that can be found in the 7 * LICENSE file in the root of the source tree. All contributing project authors 8 * may be found in the AUTHORS file in the root of the source tree. 9 */ 10 11 #ifndef MK_TCP_H 12 #define MK_TCP_H 13 14 #include "mk_common.h" 15 16 #ifdef __cplusplus 17 extern "C" { 18 #endif 19 20 ///////////////////////////////////////////Buffer::Ptr///////////////////////////////////////////// 21 22 typedef void *mk_buffer; 23 typedef void(API_CALL *on_mk_buffer_free)(void *user_data, void *data); 24 25 /** 26 * 创建buffer对象 27 * @param data 数据指针 28 * @param len 数据长度 29 * @param cb 数据指针free回调函数，该参数置空时，内部会拷贝数据 30 * @param user_data 数据指针free回调函数on_mk_buffer_free第一个参数 31 * @return buffer对象 32 */ 33 API_EXPORT mk_buffer API_CALL mk_buffer_from_char(const char *data, size_t len, on_mk_buffer_free cb, void *user_data); 34 API_EXPORT mk_buffer API_CALL mk_buffer_ref(mk_buffer buffer); 35 API_EXPORT void API_CALL mk_buffer_unref(mk_buffer buffer); 36 API_EXPORT const char* API_CALL mk_buffer_get_data(mk_buffer buffer); 37 API_EXPORT size_t API_CALL mk_buffer_get_size(mk_buffer buffer); 38 39 ///////////////////////////////////////////SockInfo///////////////////////////////////////////// 40 //SockInfo对象的C映射 41 typedef void* mk_sock_info; 42 43 //SockInfo::get_peer_ip() 44 API_EXPORT const char* API_CALL mk_sock_info_peer_ip(const mk_sock_info ctx, char *buf); 45 //SockInfo::get_local_ip() 46 API_EXPORT const char* API_CALL mk_sock_info_local_ip(const mk_sock_info ctx, char *buf); 47 //SockInfo::get_peer_port() 48 API_EXPORT uint16_t API_CALL mk_sock_info_peer_port(const mk_sock_info ctx); 49 //SockInfo::get_local_port() 50 API_EXPORT uint16_t API_CALL mk_sock_info_local_port(const mk_sock_info ctx); 51 52 #ifndef SOCK_INFO_API_RENAME 53 #define SOCK_INFO_API_RENAME 54 //mk_tcp_session对象转换成mk_sock_info对象后再获取网络相关信息 55 #define mk_tcp_session_peer_ip(x,buf) mk_sock_info_peer_ip(mk_tcp_session_get_sock_info(x),buf) 56 #define mk_tcp_session_local_ip(x,buf) mk_sock_info_local_ip(mk_tcp_session_get_sock_info(x),buf) 57 #define mk_tcp_session_peer_port(x) mk_sock_info_peer_port(mk_tcp_session_get_sock_info(x)) 58 #define mk_tcp_session_local_port(x) mk_sock_info_local_port(mk_tcp_session_get_sock_info(x)) 59 60 //mk_tcp_client对象转换成mk_sock_info对象后再获取网络相关信息 61 #define mk_tcp_client_peer_ip(x,buf) mk_sock_info_peer_ip(mk_tcp_client_get_sock_info(x),buf) 62 #define mk_tcp_client_local_ip(x,buf) mk_sock_info_local_ip(mk_tcp_client_get_sock_info(x),buf) 63 #define mk_tcp_client_peer_port(x) mk_sock_info_peer_port(mk_tcp_client_get_sock_info(x)) 64 #define mk_tcp_client_local_port(x) mk_sock_info_local_port(mk_tcp_client_get_sock_info(x)) 65 #endif 66 ///////////////////////////////////////////TcpSession///////////////////////////////////////////// 67 //TcpSession对象的C映射 68 typedef void* mk_tcp_session; 69 typedef void* mk_tcp_session_ref; 70 71 //获取基类指针以便获取其网络相关信息 72 API_EXPORT mk_sock_info API_CALL mk_tcp_session_get_sock_info(const mk_tcp_session ctx); 73 74 //TcpSession::safeShutdown() 75 API_EXPORT void API_CALL mk_tcp_session_shutdown(const mk_tcp_session ctx,int err,const char *err_msg); 76 //TcpSession::send() 77 API_EXPORT void API_CALL mk_tcp_session_send(const mk_tcp_session ctx, const char *data, size_t len); 78 API_EXPORT void API_CALL mk_tcp_session_send_buffer(const mk_tcp_session ctx, mk_buffer buffer); 79 80 //切换到该对象所在线程后再TcpSession::send() 81 API_EXPORT void API_CALL mk_tcp_session_send_safe(const mk_tcp_session ctx, const char *data, size_t len); 82 API_EXPORT void API_CALL mk_tcp_session_send_buffer_safe(const mk_tcp_session ctx, mk_buffer buffer); 83 84 //创建mk_tcp_session的弱引用 85 API_EXPORT mk_tcp_session_ref API_CALL mk_tcp_session_ref_from(const mk_tcp_session ctx); 86 //删除mk_tcp_session的弱引用 87 API_EXPORT void mk_tcp_session_ref_release(const mk_tcp_session_ref ref); 88 //根据弱引用获取mk_tcp_session，如果mk_tcp_session已经销毁，那么返回NULL 89 API_EXPORT mk_tcp_session mk_tcp_session_from_ref(const mk_tcp_session_ref ref); 90 91 ///////////////////////////////////////////自定义tcp服务///////////////////////////////////////////// 92 93 typedef struct { 94 /** 95 * 收到mk_tcp_session创建对象 96 * @param server_port 服务器端口号 97 * @param session 会话处理对象 98 */ 99 void (API_CALL *on_mk_tcp_session_create)(uint16_t server_port,mk_tcp_session session); 100 101 /** 102 * 收到客户端发过来的数据 103 * @param server_port 服务器端口号 104 * @param session 会话处理对象 105 * @param buffer 数据 106 */ 107 void (API_CALL *on_mk_tcp_session_data)(uint16_t server_port,mk_tcp_session session, mk_buffer buffer); 108 109 /** 110 * 每隔2秒的定时器，用于管理超时等任务 111 * @param server_port 服务器端口号 112 * @param session 会话处理对象 113 */ 114 void (API_CALL *on_mk_tcp_session_manager)(uint16_t server_port,mk_tcp_session session); 115 116 /** 117 * 一般由于客户端断开tcp触发 118 * @param server_port 服务器端口号 119 * @param session 会话处理对象 120 * @param code 错误代码 121 * @param msg 错误提示 122 */ 123 void (API_CALL *on_mk_tcp_session_disconnect)(uint16_t server_port,mk_tcp_session session,int code,const char *msg); 124 } mk_tcp_session_events; 125 126 127 typedef enum { 128 //普通的tcp 129 mk_type_tcp = 0, 130 //ssl类型的tcp 131 mk_type_ssl = 1, 132 //基于websocket的连接 133 mk_type_ws = 2, 134 //基于ssl websocket的连接 135 mk_type_wss = 3 136 }mk_tcp_type; 137 138 /** 139 * tcp会话对象附着用户数据 140 * 该函数只对mk_tcp_server_server_start启动的服务类型有效 141 * @param session 会话对象 142 * @param user_data 用户数据指针 143 */ 144 API_EXPORT void API_CALL mk_tcp_session_set_user_data(mk_tcp_session session,void *user_data); 145 146 /** 147 * 获取tcp会话对象上附着的用户数据 148 * 该函数只对mk_tcp_server_server_start启动的服务类型有效 149 * @param session tcp会话对象 150 * @return 用户数据指针 151 */ 152 API_EXPORT void* API_CALL mk_tcp_session_get_user_data(mk_tcp_session session); 153 154 /** 155 * 开启tcp服务器 156 * @param port 监听端口号，0则为随机 157 * @param type 服务器类型 158 */ 159 API_EXPORT uint16_t API_CALL mk_tcp_server_start(uint16_t port, mk_tcp_type type); 160 161 /** 162 * 监听tcp服务器事件 163 */ 164 API_EXPORT void API_CALL mk_tcp_server_events_listen(const mk_tcp_session_events *events); 165 166 167 ///////////////////////////////////////////自定义tcp客户端///////////////////////////////////////////// 168 169 typedef void* mk_tcp_client; 170 //获取基类指针以便获取其网络相关信息 171 API_EXPORT mk_sock_info API_CALL mk_tcp_client_get_sock_info(const mk_tcp_client ctx); 172 173 typedef struct { 174 /** 175 * tcp客户端连接服务器成功或失败回调 176 * @param client tcp客户端 177 * @param code 0为连接成功，否则为失败原因 178 * @param msg 连接失败错误提示 179 */ 180 void (API_CALL *on_mk_tcp_client_connect)(mk_tcp_client client,int code,const char *msg); 181 182 /** 183 * tcp客户端与tcp服务器之间断开回调 184 * 一般是eof事件导致 185 * @param client tcp客户端 186 * @param code 错误代码 187 * @param msg 错误提示 188 */ 189 void (API_CALL *on_mk_tcp_client_disconnect)(mk_tcp_client client,int code,const char *msg); 190 191 /** 192 * 收到tcp服务器发来的数据 193 * @param client tcp客户端 194 * @param buffer 数据 195 */ 196 void (API_CALL *on_mk_tcp_client_data)(mk_tcp_client client, mk_buffer buffer); 197 198 /** 199 * 每隔2秒的定时器，用于管理超时等任务 200 * @param client tcp客户端 201 */ 202 void (API_CALL *on_mk_tcp_client_manager)(mk_tcp_client client); 203 } mk_tcp_client_events; 204 205 /** 206 * 创建tcp客户端 207 * @param events 回调函数结构体 208 * @param user_data 用户数据指针 209 * @param type 客户端类型 210 * @return 客户端对象 211 */ 212 API_EXPORT mk_tcp_client API_CALL mk_tcp_client_create(mk_tcp_client_events *events, mk_tcp_type type); 213 214 /** 215 * 释放tcp客户端 216 * @param ctx 客户端对象 217 */ 218 API_EXPORT void API_CALL mk_tcp_client_release(mk_tcp_client ctx); 219 220 /** 221 * 发起连接 222 * @param ctx 客户端对象 223 * @param host 服务器ip或域名 224 * @param port 服务器端口号 225 * @param time_out_sec 超时时间 226 */ 227 API_EXPORT void API_CALL mk_tcp_client_connect(mk_tcp_client ctx, const char *host, uint16_t port, float time_out_sec); 228 229 /** 230 * 非线程安全的发送数据 231 * 开发者如果能确保在本对象网络线程内，可以调用此此函数 232 * @param ctx 客户端对象 233 * @param data 数据指针 234 * @param len 数据长度，等于0时，内部通过strlen获取 235 */ 236 API_EXPORT void API_CALL mk_tcp_client_send(mk_tcp_client ctx, const char *data, int len); 237 API_EXPORT void API_CALL mk_tcp_client_send_buffer(mk_tcp_client ctx, mk_buffer buffer); 238 239 /** 240 * 切换到本对象的网络线程后再发送数据 241 * @param ctx 客户端对象 242 * @param data 数据指针 243 * @param len 数据长度，等于0时，内部通过strlen获取 244 */ 245 API_EXPORT void API_CALL mk_tcp_client_send_safe(mk_tcp_client ctx, const char *data, int len); 246 API_EXPORT void API_CALL mk_tcp_client_send_buffer_safe(mk_tcp_client ctx, mk_buffer buffer); 247 248 /** 249 * 客户端附着用户数据 250 * @param ctx 客户端对象 251 * @param user_data 用户数据指针 252 */ 253 API_EXPORT void API_CALL mk_tcp_client_set_user_data(mk_tcp_client ctx,void *user_data); 254 255 /** 256 * 获取客户端对象上附着的用户数据 257 * @param ctx 客户端对象 258 * @return 用户数据指针 259 */ 260 API_EXPORT void* API_CALL mk_tcp_client_get_user_data(mk_tcp_client ctx); 261 262 #ifdef __cplusplus 263 } 264 #endif 265 #endif //MK_TCP_H 266