luat_network_adapter.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  1. #ifndef __LUAT_NW_ADAPTER_H__
  2. #define __LUAT_NW_ADAPTER_H__
  3. #include "luat_base.h"
  4. // #ifdef LUAT_USE_NETWORK
  5. #if defined(LUAT_EC7XX_CSDK) || defined(CHIP_EC618) || defined(__AIR105_BSP__)
  6. #include "bsp_common.h"
  7. #endif
  8. #include "luat_rtos.h"
  9. #ifndef __BSP_COMMON_H__
  10. #include "c_common.h"
  11. #endif
  12. #ifdef LUAT_USE_TLS
  13. #include "mbedtls/ssl.h"
  14. #include "mbedtls/platform.h"
  15. #include "mbedtls/debug.h"
  16. #include "mbedtls/x509_crt.h"
  17. #include "mbedtls/base64.h"
  18. #include "mbedtls/ctr_drbg.h"
  19. #include "mbedtls/entropy.h"
  20. #include "mbedtls/sha1.h"
  21. #endif
  22. #ifdef LUAT_USE_LWIP
  23. #include "lwip/opt.h"
  24. #include "lwip/netif.h"
  25. #include "lwip/timeouts.h"
  26. #include "lwip/priv/tcp_priv.h"
  27. #include "lwip/def.h"
  28. #include "lwip/memp.h"
  29. #include "lwip/priv/tcpip_priv.h"
  30. #include "lwip/ip4_frag.h"
  31. #include "lwip/etharp.h"
  32. #include "lwip/dhcp.h"
  33. #include "lwip/prot/dhcp.h"
  34. #include "lwip/autoip.h"
  35. #include "lwip/igmp.h"
  36. #include "lwip/dns.h"
  37. #include "lwip/nd6.h"
  38. #include "lwip/ip6_frag.h"
  39. #include "lwip/mld6.h"
  40. #include "lwip/dhcp6.h"
  41. #include "lwip/sys.h"
  42. #include "lwip/pbuf.h"
  43. #include "lwip/inet.h"
  44. #endif
  45. #define MAX_DNS_IP (4) //每个URL最多保留4个IP
  46. enum
  47. {
  48. EV_NW_RESET = USER_EVENT_ID_START + 0x1000000,
  49. EV_NW_STATE,
  50. EV_NW_TIMEOUT,
  51. EV_NW_DNS_RESULT,
  52. EV_NW_SOCKET_TX_OK,
  53. EV_NW_SOCKET_RX_NEW,
  54. EV_NW_SOCKET_RX_FULL,
  55. EV_NW_SOCKET_CLOSE_OK,
  56. EV_NW_SOCKET_REMOTE_CLOSE,
  57. EV_NW_SOCKET_CONNECT_OK,
  58. EV_NW_SOCKET_ERROR,
  59. EV_NW_SOCKET_LISTEN,
  60. EV_NW_SOCKET_NEW_CONNECT, //作为server接收到新的connect,只有允许accept操作的才有,否则直接上报CONNECT_OK
  61. EV_NW_BREAK_WAIT,
  62. EV_NW_END,
  63. NW_STATE_LINK_OFF = 0,
  64. NW_STATE_OFF_LINE,
  65. NW_STATE_WAIT_DNS,
  66. NW_STATE_CONNECTING,
  67. NW_STATE_SHAKEHAND,
  68. NW_STATE_ONLINE,
  69. NW_STATE_LISTEN,
  70. NW_STATE_DISCONNECTING,
  71. NW_WAIT_NONE = 0,
  72. NW_WAIT_LINK_UP,
  73. NW_WAIT_ON_LINE,
  74. NW_WAIT_TX_OK,
  75. NW_WAIT_OFF_LINE,
  76. NW_WAIT_EVENT,
  77. //一旦使用高级API,回调会改为下面的,param1 = 0成功,其他失败
  78. EV_NW_RESULT_BASE = EV_NW_END + 1,
  79. EV_NW_RESULT_LINK = EV_NW_RESULT_BASE + NW_WAIT_LINK_UP,
  80. EV_NW_RESULT_CONNECT = EV_NW_RESULT_BASE + NW_WAIT_ON_LINE,
  81. EV_NW_RESULT_CLOSE = EV_NW_RESULT_BASE + NW_WAIT_OFF_LINE,
  82. EV_NW_RESULT_TX = EV_NW_RESULT_BASE + NW_WAIT_TX_OK,
  83. EV_NW_RESULT_EVENT = EV_NW_RESULT_BASE + NW_WAIT_EVENT,
  84. NW_ADAPTER_INDEX_LWIP_NONE = 0,
  85. NW_ADAPTER_INDEX_LWIP_GPRS, //蜂窝网络模块
  86. NW_ADAPTER_INDEX_LWIP_WIFI_STA, //WIFI SOC
  87. NW_ADAPTER_INDEX_LWIP_WIFI_AP, //WIFI SOC
  88. NW_ADAPTER_INDEX_LWIP_ETH, //自带以太网控制器的SOC
  89. NW_ADAPTER_INDEX_LWIP_NETIF_QTY,
  90. NW_ADAPTER_INDEX_HW_PS_DEVICE = NW_ADAPTER_INDEX_LWIP_NETIF_QTY,
  91. NW_ADAPTER_INDEX_ETH0 = NW_ADAPTER_INDEX_HW_PS_DEVICE, //外挂以太网+硬件协议栈
  92. NW_ADAPTER_INDEX_USB, //USB网卡
  93. NW_ADAPTER_INDEX_POSIX, // 对接POSIX
  94. NW_ADAPTER_INDEX_LUAPROXY, // 代理到Lua层
  95. NW_ADAPTER_INDEX_CUSTOM, // 对接到自定义适配器
  96. NW_ADAPTER_QTY,
  97. NW_CMD_AUTO_HEART_TIME = 0,
  98. };
  99. #ifdef LUAT_USE_LWIP
  100. #define luat_ip_addr_t ip_addr_t
  101. #else
  102. typedef struct
  103. {
  104. union
  105. {
  106. uint32_t ipv4;
  107. uint32_t ipv6_u32_addr[4];
  108. uint8_t ipv6_u8_addr[16];
  109. };
  110. uint8_t is_ipv6;
  111. }luat_ip_addr_t;
  112. uint8_t network_string_is_ipv4(const char *string, uint32_t len);
  113. uint32_t network_string_to_ipv4(const char *string, uint32_t len);
  114. int network_string_to_ipv6(const char *string, luat_ip_addr_t *ip_addr);
  115. #endif
  116. typedef struct
  117. {
  118. uint64_t tag;
  119. void *param;
  120. }luat_network_cb_param_t;
  121. typedef struct
  122. {
  123. uint32_t ttl_end;
  124. luat_ip_addr_t ip;
  125. }luat_dns_ip_result;
  126. typedef struct
  127. {
  128. /* data */
  129. llist_head node;
  130. Buffer_Struct uri;
  131. luat_dns_ip_result result[MAX_DNS_IP];
  132. uint8_t ip_nums;
  133. }luat_dns_cache_t;
  134. typedef struct
  135. {
  136. uint64_t tx_size;
  137. uint64_t ack_size;
  138. uint64_t tag;
  139. #ifdef LUAT_USE_TLS
  140. //SSL相关数据均为动态生成的,需要在close的时候释放
  141. mbedtls_ssl_context *ssl; /**< mbed TLS control context. */
  142. mbedtls_ssl_config *config; /**< mbed TLS configuration context. */
  143. mbedtls_x509_crt *ca_cert;
  144. #endif
  145. CBFuncEx_t user_callback;
  146. void *user_data; //传递给user_callback的pParam
  147. void *socket_param; //一般用来存放network_ctrl本身,用于快速查找
  148. HANDLE task_handle;
  149. HANDLE timer;
  150. HANDLE tls_short_timer;
  151. HANDLE tls_long_timer;
  152. HANDLE mutex;
  153. uint32_t tcp_keep_idle;
  154. int socket_id;
  155. char *domain_name; //动态生成的,需要在close的时候释放
  156. uint32_t domain_name_len;
  157. luat_ip_addr_t remote_ip;
  158. luat_dns_ip_result *dns_ip; //动态生成的,需要在close的时候释放
  159. luat_ip_addr_t *online_ip; //指向某个ip,无需释放
  160. uint16_t remote_port;
  161. uint16_t local_port;
  162. uint8_t *cache_data; //动态生成的,需要在close的时候释放
  163. uint32_t cache_len;
  164. int tls_timer_state;
  165. uint32_t tcp_timeout_ms;
  166. uint8_t tls_mode;
  167. uint8_t tls_need_reshakehand;
  168. uint8_t need_close;
  169. uint8_t new_rx_flag;
  170. uint8_t dns_ip_cnt;
  171. uint8_t dns_ip_nums;
  172. uint8_t tcp_keep_alive;
  173. uint8_t tcp_keep_interval;
  174. uint8_t tcp_keep_cnt;
  175. uint8_t adapter_index;
  176. uint8_t is_tcp;
  177. uint8_t is_server_mode;
  178. uint8_t auto_mode;
  179. uint8_t wait_target_state;
  180. uint8_t state;
  181. uint8_t is_debug;
  182. uint8_t domain_ipv6;
  183. }network_ctrl_t;
  184. typedef struct
  185. {
  186. uint64_t tag;
  187. #ifdef LUAT_USE_LWIP
  188. llist_head wait_ack_head;
  189. #endif
  190. llist_head tx_head;
  191. llist_head rx_head;
  192. uint32_t rx_wait_size;
  193. uint32_t tx_wait_size;
  194. #ifdef LUAT_USE_LWIP
  195. union {
  196. struct ip_pcb *ip;
  197. struct tcp_pcb *tcp;
  198. struct udp_pcb *udp;
  199. struct raw_pcb *raw;
  200. } pcb;
  201. struct tcp_pcb_listen *listen_tcp;
  202. HANDLE mutex;
  203. uint16_t local_port;
  204. uint16_t remote_port;
  205. #endif
  206. void *param;
  207. uint8_t state;
  208. uint8_t is_tcp;
  209. uint8_t is_ipv6;
  210. uint8_t in_use;
  211. uint8_t rx_waiting;
  212. uint8_t remote_close;
  213. uint8_t fast_rx_ack; //TCP快速应答
  214. }socket_ctrl_t; //推荐底层协议栈适配用的socket状态结构
  215. /*
  216. * info内的api必须全部是非阻塞的及任务的,并且对socket_id和tag做合法性检查
  217. * 目前只支持tcp和udp,不支持raw
  218. * 如果没有特殊说明,成功返回=0,失败返回<0
  219. */
  220. typedef struct
  221. {
  222. //检查网络是否准备好,返回非0准备好,user_data是注册时的user_data,传入给底层api
  223. uint8_t (*check_ready)(void *user_data);
  224. //创建一个socket,并设置成非阻塞模式,user_data传入对应适配器, tag作为socket的合法依据,给check_socket_vaild比对用
  225. //成功返回socketid,失败 < 0
  226. int (*create_soceket)(uint8_t is_tcp, uint64_t *tag, void *param, uint8_t is_ipv6, void *user_data);
  227. //作为client绑定一个port,并连接remote_ip和remote_port对应的server
  228. //成功返回0,失败 < 0
  229. int (*socket_connect)(int socket_id, uint64_t tag, uint16_t local_port, luat_ip_addr_t *remote_ip, uint16_t remote_port, void *user_data);
  230. //作为server绑定一个port,开始监听
  231. //成功返回0,失败 < 0
  232. int (*socket_listen)(int socket_id, uint64_t tag, uint16_t local_port, void *user_data);
  233. //作为server接受一个client
  234. //成功返回0,失败 < 0
  235. int (*socket_accept)(int socket_id, uint64_t tag, luat_ip_addr_t *remote_ip, uint16_t *remote_port, void *user_data);
  236. //主动断开一个tcp连接,需要走完整个tcp流程,用户需要接收到close ok回调才能确认彻底断开
  237. //成功返回0,失败 < 0
  238. int (*socket_disconnect)(int socket_id, uint64_t tag, void *user_data);
  239. //释放掉socket的控制权,除了tag异常外,必须立刻生效
  240. //成功返回0,失败 < 0
  241. int (*socket_close)(int socket_id, uint64_t tag, void *user_data);
  242. //强行释放掉socket的控制权,必须立刻生效
  243. //成功返回0,失败 < 0
  244. int (*socket_force_close)(int socket_id, void *user_data);
  245. //tcp时,不需要remote_ip和remote_port,如果buf为NULL,则返回当前缓存区的数据量,当返回值小于len时说明已经读完了
  246. //udp时,只返回1个block数据,需要多次读直到没有数据为止
  247. //成功返回实际读取的值,失败 < 0
  248. int (*socket_receive)(int socket_id, uint64_t tag, uint8_t *buf, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t *remote_port, void *user_data);
  249. //tcp时,不需要remote_ip和remote_port
  250. //成功返回>0的len,缓冲区满了=0,失败 < 0,如果发送了len=0的空包,也是返回0,注意判断
  251. int (*socket_send)(int socket_id, uint64_t tag, const uint8_t *buf, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t remote_port, void *user_data);
  252. //检查socket合法性,成功返回0,失败 < 0
  253. int (*socket_check)(int socket_id, uint64_t tag, void *user_data);
  254. //保留有效的socket,将无效的socket关闭
  255. void (*socket_clean)(int *vaild_socket_list, uint32_t num, void *user_data);
  256. int (*getsockopt)(int socket_id, uint64_t tag, int level, int optname, void *optval, uint32_t *optlen, void *user_data);
  257. int (*setsockopt)(int socket_id, uint64_t tag, int level, int optname, const void *optval, uint32_t optlen, void *user_data);
  258. //非posix的socket,用这个根据实际硬件设置参数
  259. int (*user_cmd)(int socket_id, uint64_t tag, uint32_t cmd, uint32_t value, void *user_data);
  260. int (*dns)(const char *domain_name, uint32_t len, void *param, void *user_data);
  261. int (*dns_ipv6)(const char *domain_name, uint32_t len, void *param, void *user_data);
  262. int (*set_dns_server)(uint8_t server_index, luat_ip_addr_t *ip, void *user_data);
  263. int (*set_mac)(uint8_t *mac, void *user_data);
  264. int (*set_static_ip)(luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway, luat_ip_addr_t *ipv6, void *user_data);
  265. int (*get_full_ip_info)(luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway, luat_ip_addr_t *ipv6, void *user_data);
  266. int (*get_local_ip_info)(luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway, void *user_data);
  267. //所有网络消息都是通过cb_fun回调
  268. //cb_fun回调时第一个参数为OS_EVENT,包含了socket的必要信息,第二个是luat_network_cb_param_t,其中的param是这里传入的param(就是适配器序号)
  269. //OS_EVENT ID为EV_NW_XXX,param1是socket id param2是各自参数 param3是create_soceket传入的socket_param(就是network_ctrl *)
  270. //dns结果是特别的,ID为EV_NW_SOCKET_DNS_RESULT,param1是获取到的IP数据量,0就是失败了,param2是ip组,动态分配的, param3是dns传入的param(就是network_ctrl *)
  271. void (*socket_set_callback)(CBFuncEx_t cb_fun, void *param, void *user_data);
  272. char *name;
  273. int max_socket_num;//最大socket数量,也是最大network_ctrl申请数量的基础值
  274. uint8_t no_accept;
  275. uint8_t is_posix;
  276. }network_adapter_info;
  277. /*
  278. * api有可能涉及到任务安全要求,不可以在中断里运行,只能在task中运行
  279. */
  280. //获取最后一个注册的适配器序号
  281. int network_get_last_register_adapter(void);
  282. /****************************以下是通用基础api********************************************************/
  283. /*
  284. * 在使用之后任意API前,必须先注册相关的协议栈接口
  285. * 没有可逆的api
  286. */
  287. int network_register_adapter(uint8_t adapter_index, network_adapter_info *info, void *user_data);
  288. void network_register_set_default(uint8_t adapter_index);
  289. void network_set_dns_server(uint8_t adapter_index, uint8_t server_index, luat_ip_addr_t *ip);
  290. /*
  291. * 申请一个network_ctrl
  292. */
  293. network_ctrl_t *network_alloc_ctrl(uint8_t adapter_index);
  294. /*
  295. * 归还一个network_ctrl
  296. */
  297. void network_release_ctrl(network_ctrl_t *ctrl);
  298. /*
  299. * 在使用network_ctrl前,必须先初始化
  300. * lua调用c时,必须使用非阻塞接口,task_handle,callback,param都不需要
  301. * 在纯c调用时,如果不需要则塞应用,必须有callback和param
  302. * 在纯c调用时,如果需要阻塞应用,则必须有task_handle,建议有callback,param,可以等待消息时,同时在callback中处理其他类型的消息
  303. */
  304. void network_init_ctrl(network_ctrl_t *ctrl, HANDLE task_handle, CBFuncEx_t callback, void *param);
  305. /*
  306. * 设置是tcp还是udp模式及TCP自动保活相关参数,也可以直接改network_ctrl_t中的is_tcp参数
  307. * 设置必须在socket处于close状态,在进行connect和tls初始之前
  308. */
  309. void network_set_base_mode(network_ctrl_t *ctrl, uint8_t is_tcp, uint32_t tcp_timeout_ms, uint8_t keep_alive, uint32_t keep_idle, uint8_t keep_interval, uint8_t keep_cnt);
  310. /**
  311. * 使用域名时是否选择IPV6地址
  312. */
  313. void network_connect_ipv6_domain(network_ctrl_t *ctrl, uint8_t onoff);
  314. /*
  315. * 检查网络是否已经连接,注意不是socket
  316. * 如果ctrl为0,则会根据adapter_index去返回
  317. * 返回非0是已连接,可以开始socket操作
  318. */
  319. uint8_t network_check_ready(network_ctrl_t *ctrl, uint8_t adapter_index);
  320. /*
  321. * 设置本地port,注意不要用60000及以上,如果local_port为0,系统从60000开始随机抽一个
  322. * 如果local_port不为0,且重复了,则返回-1,其他返回0
  323. */
  324. int network_set_local_port(network_ctrl_t *ctrl, uint16_t local_port);
  325. //创建一个socket
  326. //成功返回0,失败 < 0
  327. int network_create_soceket(network_ctrl_t *ctrl, uint8_t is_ipv6);
  328. //作为client连接server
  329. //成功返回0,失败 < 0
  330. int network_socket_connect(network_ctrl_t *ctrl, luat_ip_addr_t *remote_ip);
  331. //作为server开始监听
  332. //成功返回0,失败 < 0
  333. int network_socket_listen(network_ctrl_t *ctrl);
  334. uint8_t network_accept_enable(network_ctrl_t *ctrl);
  335. //作为server接受一个client
  336. //成功返回0,失败 < 0
  337. int network_socket_accept(network_ctrl_t *ctrl, network_ctrl_t *accept_ctrl);
  338. //主动断开一个tcp连接,需要走完整个tcp流程,用户需要接收到close ok回调才能确认彻底断开
  339. //成功返回0,失败 < 0
  340. int network_socket_disconnect(network_ctrl_t *ctrl);
  341. //释放掉socket的控制权
  342. //成功返回0,失败 < 0
  343. int network_socket_close(network_ctrl_t *ctrl);
  344. //强行释放掉socket的控制权
  345. //成功返回0,失败 < 0
  346. int network_socket_force_close(network_ctrl_t *ctrl);
  347. //tcp时,不需要remote_ip和remote_port,如果buf为NULL,则返回当前缓存区的数据量,当返回值小于len时说明已经读完了
  348. //udp时,只返回1个block数据,需要多次读直到没有数据为止
  349. //成功返回实际读取的值,失败 < 0
  350. int network_socket_receive(network_ctrl_t *ctrl,uint8_t *buf, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t *remote_port);
  351. //tcp时,不需要remote_ip和remote_port
  352. //成功返回0,失败 < 0
  353. int network_socket_send(network_ctrl_t *ctrl,const uint8_t *buf, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t remote_port);
  354. int network_getsockopt(network_ctrl_t *ctrl, int level, int optname, void *optval, uint32_t *optlen);
  355. int network_setsockopt(network_ctrl_t *ctrl, int level, int optname, const void *optval, uint32_t optlen);
  356. //非posix的socket,用这个根据实际硬件设置参数
  357. int network_user_cmd(network_ctrl_t *ctrl, uint32_t cmd, uint32_t value);
  358. #ifdef LUAT_USE_LWIP
  359. int network_set_mac(uint8_t adapter_index, uint8_t *mac);
  360. int network_set_static_ip_info(uint8_t adapter_index, luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway, luat_ip_addr_t *ipv6);
  361. #endif
  362. int network_get_local_ip_info(network_ctrl_t *ctrl, luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway);
  363. void network_force_close_socket(network_ctrl_t *ctrl);
  364. //url已经是ip形式了,返回1,并且填充remote_ip
  365. //成功返回0,失败 < 0
  366. int network_dns(network_ctrl_t *ctrl);
  367. void network_clean_invaild_socket(uint8_t adapter_index);
  368. const char *network_ctrl_state_string(uint8_t state);
  369. const char *network_ctrl_wait_state_string(uint8_t state);
  370. const char *network_ctrl_callback_event_string(uint32_t event);
  371. /****************************通用基础api结束********************************************************/
  372. /****************************tls相关api************************************************************/
  373. /*
  374. * 给DTLS设置PSK,给UDP加密传输时用的
  375. */
  376. int network_set_psk_info(network_ctrl_t *ctrl,
  377. const unsigned char *psk, size_t psk_len,
  378. const unsigned char *psk_identity, size_t psk_identity_len);
  379. /*
  380. * TLS设置验证服务器的证书,可以不用
  381. */
  382. int network_set_server_cert(network_ctrl_t *ctrl, const unsigned char *cert, size_t cert_len);
  383. /*
  384. * TLS设置验证客户端的证书,只有双向认证才需要,而且一般只有金融领域才需要
  385. */
  386. int network_set_client_cert(network_ctrl_t *ctrl,
  387. const unsigned char *cert, size_t certLen,
  388. const unsigned char *key, size_t keylen,
  389. const unsigned char *pwd, size_t pwdlen);
  390. /*
  391. * 获取证书验证结果
  392. */
  393. int network_cert_verify_result(network_ctrl_t *ctrl);
  394. /*
  395. * 初始化加密传输
  396. * verify_mode参考MBEDTLS_SSL_VERIFY_XXX
  397. */
  398. int network_init_tls(network_ctrl_t *ctrl, int verify_mode);
  399. /*
  400. * 结束加密传输模式,恢复成正常模式
  401. */
  402. void network_deinit_tls(network_ctrl_t *ctrl);
  403. /*
  404. * 加密传输其他非阻塞api和通用api共用,阻塞api和rtos环境相关阻塞api通用,均由api内部做相关处理
  405. */
  406. /****************************tls相关api结束************************************************************/
  407. /****************************高级api,用于实现一个完整功能***********************/
  408. //一旦使用下面的api,将由network内部自动判断状态并进行下一步操作,中间处理过程除了主动强制关闭socket,其他用户不能干预,直到达到目标状态,即使非阻塞回调也只回调最终结果。
  409. //所有阻塞状态接口,一旦收到link down,socket close, error之类的消息就会返回错误,如果是timeout,只有wait event会返回成功,其他返回失败
  410. //以下api是阻塞和非则塞均可,当network_ctrl中设置了task_handle 而且 timeout_ms > 0时为阻塞接口
  411. //返回值统一成功返回0,失败 < 0,非阻塞需要等待返回1
  412. int network_wait_link_up(network_ctrl_t *ctrl, uint32_t timeout_ms);
  413. /*
  414. * 1.进行ready检测和等待ready
  415. * 2.有remote_ip则开始连接服务器并等待连接结果
  416. * 3.没有remote_ip则开始对url进行dns解析,解析完成后对所有ip进行尝试连接直到有个成功或者全部失败
  417. * 4.如果是加密模式,还要走握手环节,等到握手环节完成后才能返回结果
  418. * local_port如果为0则api内部自动生成一个
  419. * 使用前必须确保是在close状态,建议先用network_close
  420. */
  421. int network_connect(network_ctrl_t *ctrl, const char *domain_name, uint32_t domain_name_len, luat_ip_addr_t *remote_ip, uint16_t remote_port, uint32_t timeout_ms);
  422. /*
  423. * timeout_ms = 0xffffffff 为永远等待
  424. */
  425. int network_listen(network_ctrl_t *ctrl, uint32_t timeout_ms);
  426. int network_close(network_ctrl_t *ctrl, uint32_t timeout_ms);
  427. /*
  428. * timeout_ms=0时,为非阻塞接口
  429. * UDP的时候,remote_ip和remote_port和connect不一致的时候才需要remote_ip和remote_port
  430. * TCP不看remote_ip和remote_port
  431. * 阻塞模式,*tx_len不需要看,非阻塞模式需要看*tx_len的实际长度是不是和len一致
  432. */
  433. int network_tx(network_ctrl_t *ctrl, const uint8_t *data, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t remote_port, uint32_t *tx_len, uint32_t timeout_ms);
  434. /*
  435. * 实际读到的数据量在read_len里,如果是UDP模式且为server时,需要看remote_ip和remote_port
  436. */
  437. int network_rx(network_ctrl_t *ctrl, uint8_t *data, uint32_t len, int flags, luat_ip_addr_t *remote_ip, uint16_t *remote_port, uint32_t *rx_len);
  438. /*
  439. * 接收到socket异常消息均会返回
  440. * timeout_ms=0时,为非阻塞接口
  441. * 如果为阻塞接口,out_event保存消息(拷贝,非引用),is_timeout保存是否超时
  442. * 返回0表示有数据接收或者超时返回,返回1表示切换到非阻塞等待,其他为网络异常
  443. */
  444. int network_wait_event(network_ctrl_t *ctrl, OS_EVENT *out_event, uint32_t timeout_ms, uint8_t *is_timeout);
  445. /*
  446. * 接收到socket异常,用户发送EV_NW_BREAK_WAIT,或者有新数据都会返回,如果是其他消息,通过network_init_ctrl里输入的回调函数使用,如果没有回调函数,就直接抛弃了
  447. * timeout_ms=0时,依然为阻塞接口,而且是永远等待
  448. * 返回0表示有数据接收,用户打断或者超时返回,其他为网络异常
  449. * 用户打断,is_break = 1,超时 is_timeout = 1
  450. */
  451. int network_wait_rx(network_ctrl_t *ctrl, uint32_t timeout_ms, uint8_t *is_break, uint8_t *is_timeout);
  452. /****************************高级api结束********************************************************************/
  453. // 补充函数
  454. int network_get_full_local_ip_info(network_ctrl_t *ctrl, uint8_t index, luat_ip_addr_t *ip, luat_ip_addr_t *submask, luat_ip_addr_t *gateway, luat_ip_addr_t *ipv6);
  455. //将IP设置成无效状态
  456. void network_set_ip_invaild(luat_ip_addr_t *ip);
  457. //检测IP是不是无效的,无效返回0
  458. uint8_t network_ip_is_vaild(luat_ip_addr_t *ip);
  459. //检测IP是不是IPV6类型,不是返回0
  460. uint8_t network_ip_is_ipv6(luat_ip_addr_t *ip);
  461. //检测IP是不是有效的IPV4类型,不是返回0
  462. uint8_t network_ip_is_vaild_ipv4(luat_ip_addr_t *ip);
  463. //将IP设置成IPV4
  464. void network_set_ip_ipv4(luat_ip_addr_t *ip, uint32_t ipv4);
  465. #endif
  466. // #endif