awtk/docs/manual/socket.md
2020-05-24 19:28:22 +08:00

3.6 KiB
Raw Blame History

socket

概述


函数

函数名称 说明
socket_bind 绑定到指定端口。
socket_close 关闭socket句柄。
socket_deinit tcp/udp 平台~初始化。
socket_init tcp/udp 平台初始化。
socket_resolve 解析主机名并初始化addr对象。
socket_set_blocking 设置为阻塞或非阻塞模式。
socket_wait_for_data 等待数据。

socket_bind 函数


  • 函数功能:

绑定到指定端口。

  • 函数原型:
ret_t socket_bind (int sock, int port);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。
sock int socket句柄。
port int 端口号。

socket_close 函数


  • 函数功能:

关闭socket句柄。

  • 函数原型:
ret_t socket_close (int sock);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。
sock int socket句柄。

socket_deinit 函数


  • 函数功能:

tcp/udp 平台~初始化。

  • 函数原型:
ret_t socket_deinit ();
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。

socket_init 函数


  • 函数功能:

tcp/udp 平台初始化。

  • 函数原型:
ret_t socket_init ();
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。

socket_resolve 函数


  • 函数功能:

解析主机名并初始化addr对象。

  • 函数原型:
struct sockaddr* socket_resolve (int sock, bool_t , struct sockaddr_in* addr);
  • 参数说明:
参数 类型 说明
返回值 struct sockaddr* 返回地址对象。
sock int socket句柄。
bool_t g
addr struct sockaddr_in* 地址对象。

socket_set_blocking 函数


  • 函数功能:

设置为阻塞或非阻塞模式。

  • 函数原型:
ret_t socket_set_blocking (int sock, bool_t blocking);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。
sock int socket句柄。
blocking bool_t 是否阻塞。

socket_wait_for_data 函数


  • 函数功能:

等待数据。

  • 函数原型:
ret_t socket_wait_for_data (int sock, uint32_t timeout_ms);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功否则表示失败。
sock int socket句柄。
timeout_ms uint32_t 等待时间(ms)。