在使用过程中,由于UDP的实时性较好,常用于实时视频的传输,比如直播、网络电话等,因为即使是出现了数据丢失的情况,导致视频卡帧,影响不大,所以,UDP 协议还是会被应用与对传输速度有要求,并且可以容忍出现差错的数据传输中。
参考例程:esp-idf/examples/protocols/sockets/udp_client
本次实验以 app-wifi-station 工程为基础进行实验,并将工程名改为app-wifi-udp-client。当然也可以直接使用官方例程进行实验,这里使用app-wifi-station工程进行实验是因为为了学习的连贯性,因为在app-wifi-station工程中实现了连接wifi热点;另一方面也是为了学习工程的移植。
将参考例程esp-idf/examples/protocols/sockets/udp_client/main文件下的udp_client.c文件复制到app-wifi-udp-client/main文件夹下,修改如下:
CMakeLists.txt
文件中添加 user_udp_client.c打开网络调试助手,选择协议类型,查找本地主机地址、本地主机端口号
在esp-idf/examples/protocols/sockets/udp_client/main下找到 Kconfig.projbuild文件,将该文件复制并覆盖app-wifi-udp-client/main下的 Kconfig.projbuild文件,该操作的目的是增加 IP Version、IPV4 Address、Port等参数。
使用命令 idf.py menuconfig
打开配置菜单,在菜单中配置本地IP Address和 Port,该参数值对照网络调试助手。最终配置完成后会保存在app-wifi-udp-client文件夹下的sdkconfig文件。
或者在Kconfig.projbuild 文件中直接将本地主机地址改为默认地址。
```c
config EXAMPLE_IPV4_ADDR
string "IPV4 Address"
default "192.168.3.113"
depends on EXAMPLE_IPV4
help
IPV4 address to which the client example will send data.
config EXAMPLE_PORT
int "Port"
range 0 65535
default 3333
help
The remote port to which the client example will send data.
```
实际代码中IP Address和 Port参数如下
#if defined(CONFIG_EXAMPLE_IPV4)
#define HOST_IP_ADDR CONFIG_EXAMPLE_IPV4_ADDR
#elif defined(CONFIG_EXAMPLE_IPV6)
#define HOST_IP_ADDR CONFIG_EXAMPLE_IPV6_ADDR
#else
#define HOST_IP_ADDR "" /*如果使用官网说明手册中 netcat 工具,则需要手动输入主机IP地址*/
#endif
#define PORT CONFIG_EXAMPLE_PORT
在user_udp_client.c
代码中,client task执行如下
static void udp_client_task(void *pvParameters)
{
while (1) {
/*1. 设置目标UDP server地址、端口等*/
struct sockaddr_in dest_addr;
dest_addr.sin_addr.s_addr = inet_addr(HOST_IP_ADDR);
dest_addr.sin_family = AF_INET;
dest_addr.sin_port = htons(PORT);
addr_family = AF_INET;
ip_protocol = IPPROTO_IP;
/*2. 创建socket*/
int sock = socket(addr_family, SOCK_DGRAM, ip_protocol);
while (1)
{
/* 3. 向目标UDP server发送一次数据*/
int err = sendto(sock, payload, strlen(payload), 0, (struct sockaddr *)&dest_addr, sizeof(dest_addr));
ESP_LOGI(TAG, "Message sent");
struct sockaddr_in source_addr; // Large enough for both IPv4 or IPv6
socklen_t socklen = sizeof(source_addr);
/*4. 程序会阻塞在此,直到收到UDP server数据*/
int len = recvfrom(sock, rx_buffer, sizeof(rx_buffer) - 1, 0, (struct sockaddr *)&source_addr, &socklen);
// Data received
/*5. 收到目标UDP server数据,并打印*/
rx_buffer[len] = 0; // Null-terminate whatever we received and treat like a string
ESP_LOGI(TAG, "Received %d bytes from %s:", len, host_ip);
ESP_LOGI(TAG, "%s", rx_buffer);
}
}
}
代码中使用到函数 socket
、sendto
、recvfrom
等。可参考[野火]LwIP应用开发实战指南—基于野火STM32
参考例程:examples\protocols\sockets\tcp_client
本次实验以 app-wifi-station 工程为基础进行实验,并将工程名改为app-tcp-client。当然也可以直接使用官方例程进行实验,这里使用app-wifi-station工程进行实验是因为为了学习的连贯性,因为在app-wifi-station工程中实现了连接wifi热点;另一方面也是为了学习工程的移植。
后续相关操作参考上文《1.1 UDP作为client进行数据收发实验》
查看工程代码,执行流程和《1.1 UDP作为client进行数据收发实验》类似。
参考例程:examples\protocols\sockets\tcp_server
本次实验以 app-wifi-station 工程为基础进行实验,并将工程名改为app-tcp-server。当然也可以直接使用官方例程进行实验,这里使用app-wifi-station工程进行实验是因为为了学习的连贯性,因为在app-wifi-station工程中实现了连接wifi热点;另一方面也是为了学习工程的移植。
后续相关操作参考上文《1.1 UDP作为client进行数据收发实验》
查看工程代码,
在上文三个实验中,执行流程较为类似,重点内容在于TCP协议和UDP协议,而代码中用到较多的是套接字(socket),详细内容请参考:
socket
这个函数的功能是向内核申请一个套接字
#define socket(domain,type,protocol) lwip_socket(domain,type,protocol)
int lwip_socket(int domain, int type, int protocol);
#define AF_UNSPEC 0
#define AF_INET 2
#if LWIP_IPV6
#define AF_INET6 10
#else /* LWIP_IPV6 */
#define AF_INET6 AF_UNSPEC
/* Socket 服务类型 (TCP/UDP/RAW) */
#define SOCK_STREAM 1
#define SOCK_DGRAM 2
#define SOCK_RAW 3
参数 domain : 表示该套接字使用的协议簇,对于 TCP/IP 协议来说,IPv4为 AF_INET;IPv6为AF_INET6。
参数 type : 指定了套接字使用的服务类型,可能的类型有 3 种:
参数 protocol : 指定了套接字使用的协议,在 IPv4 中,只有 TCP 协议提供 SOCK_STREAM 这种可靠的服务,只有 UDP 协议提供 SOCK_DGRAM 服务,对于这两种协议,protocol 的值均为 0。
当申请套接字成功的时候,该函数返回一个 int 类型的值,也是 Socket 描述符,用户通过这个值
可以索引到一个 Socket 连接结构——lwip_sock,当申请套接字失败时,该函数返回-1。
这个函数主要是用于 UDP 协议传输数据中,它向另一端的 UDP 主机发送一个 UDP 报文,参数 dataptr 指定了要发送数据的起始地址,而 参数size 则指定数据的长度,参数 flag 指定了发送时候的一些处理,比如外带数据等,此时我们不需要理会它,一般设置为 0 即可,参数 to 是一个指向 sockaddr 结构体的指针,在这里需要我们自己提供远端主机的 IP 地址与端口号,并且用 tolen 参数指定这些信息的长度,具体如下
#define sendto(s,dataptr,size,flags,to,tolen) lwip_sendto(s,dataptr,size,flags,to,tolen)
ssize_t lwip_sendto(int s, const void *data, size_t size, int flags,const struct sockaddr *to, socklen_t tolen)
ead() 与 recv() 函数的核心是调用 recvfrom() 函数,recv() 与 read() 函数用于从 Socket 中接收数据,它们可以是 TCP 协议和 UDP 协议,具体
#define read(s,mem,len) lwip_read(s,mem,len)
ssize_t lwip_read(int s, void *mem, size_t len)
{
return lwip_recvfrom(s, mem, len, 0, NULL, NULL);
}
#define recv(s,mem,len,flags) lwip_recv(s,mem,len,flags)
ssize_t lwip_recv(int s, void *mem, size_t len, int flags)
{
return lwip_recvfrom(s, mem, len, flags, NULL, NULL);
}
#define recvfrom(s,mem,len,flags,from,fromlen) lwip_recvfrom(s,mem,len,flags,from,fromlen)
ssize_t lwip_recvfrom(int s, void *mem, size_t len, int flags,struct sockaddr *from, socklen_t *fromlen)
men 参数记录了接收数据的缓存起始地址,
len参数 用于指定接收数据的最大长度,如果函数能正确接收到数据,将会返回一个接收到数据的长度,否则将返回-1,若返回值为 0,表示连接已经终止,应用程序可以根据返回的值进行不一样的操作。
flags 参数我们暂时可以直接忽略它,设置为 0 即可。
注意,如果接收的数据大于用户提供的缓存区,那么多余的数据会被直接丢弃。
close() 函数是用于关闭一个指定的套接字,在关闭套接字后,将无法使用对应的套接字描述符索引到连接结构,该函数的本质是对 netconn_delete() 函数的封装(真正处理的函数是 net-conn_prepare_delete()),如果连接是 TCP 协议,将产生一个请求终止连接的报文发送到对端主机中,如果是 UDP 协议,将直接释放 UDP 控制块的内容,具体如下
#define close(s) lwip_close(s)
int lwip_close(int s)
connect
这个函数用于客户端中,将 Socket 与远端 IP 地址、端口号进行绑定,在 TCP 客户端连接中,调用这个函数将发生握手过程(会发送一个 TCP 连接请求),并最终建立新的 TCP 连接,而对于 UDP协议来说,调用这个函数只是在 UDP 控制块中记录远端 IP 地址与端口号,而不发送任何数据,参数信息与 bind() 函数是一样的
#define connect(s,name,namelen) lwip_connect(s,name,namelen)
intlwip_connect(int s,const struct sockaddr *name,socklen_t namelen);
send() 函数可以用于 UDP 协议和 TCP 连接发送数据。在调用 send() 函数之前,必须使用 connect()函数将远端主机的 IP 地址、端口号与 Socket 连接结构进行绑定。对于 UDP 协议,send() 函数将调用 lwip_sendto() 函数发送数据,而对于 TCP 协议,将调用 netconn_write_partly() 函数发送数据。相对于 sendto() 函数,参数基本是没啥区别的,但无需我们设置远端主机的信息,更加方便操作,因此这个函数在实际中使用也是很多的,具体
#define send(s,dataptr,size,flags) lwip_send(s,dataptr,size,flags)
ssize_t lwip_send(int s, const void *data, size_t size, int flags)
bind
该函数用于服务器端绑定套接字与网卡信息
#define bind(s,name,namelen) lwip_bind(s,name,namelen)
int lwip_bind(int s,const struct sockaddr *name,socklen_t namelen);
参数 s 是表示要绑定的 Socket 套接字,注意了,这个套接字必须是从 socket() 函数中返回的索引,否则将无法完成绑定操作。
参数 name 是一个指向 sockaddr 结构体的指针,其中包含了网卡的 IP 地址、端口号等重要的信息,LwIP 为了更好描述这些信息,使用了 sockaddr 结构体来定义了必要的信息的字段,它常被用于Socket API 的很多函数中,我们在使用 bind() 的时候,只需要直接填写相关字段即可,sockaddr 结构体如下
struct sockaddr {
u8_t sa_len; /*长度*/
sa_family_t sa_family; /*协议簇*/
char sa_data[14]; /* 连续的 14 字节信息 */
};
我们需要填写的 IP 地址与端口号等信息,都在 sa_data 连续的 14 字节信息里面,但是这个数据对我们不友好,因此 LwIP还定义了另一个对开发者更加友好的结构体——sockaddr_in,我们一般也是用这个结构体,
struct sockaddr_in
{
u8_t sin_len;
sa_family_t sin_family;
in_port_t sin_port;
struct in_addr sin_addr;
#define SIN_ZERO_LEN 8
char sin_zero[SIN_ZERO_LEN];
};
这个结构体的前两个字段是与 sockaddr 结构体的前两个字段一致,而剩下的字段就是 sa_data 连续的 14 字节信息里面的内容,只不过从新定义了成员变量而已,sin_port 字段是我们需要填写的端口号信息,sin_addr 字段是我们需要填写的 IP 地址信息,剩下 sin_zero 区域的 8 字节保留未用。
但在本章实验中为了兼容IPv6,所以初始定义时都是使用sockaddr_in6结构体,如下所示
struct sockaddr_in6 {
u8_t sin6_len; /* length of this structure */
sa_family_t sin6_family; /* AF_INET6 */
in_port_t sin6_port; /* Transport layer port # */
u32_t sin6_flowinfo; /* IPv6 flow information */
struct in6_addr sin6_addr; /* IPv6 address */
u32_t sin6_scope_id; /* Set of interfaces for scope */
};
如果使用的是IPv4则会强制转化为sockaddr_in
struct sockaddr_in6 dest_addr;
if (addr_family == AF_INET)
{
struct sockaddr_in *dest_addr_ip4 = (struct sockaddr_in *)&dest_addr;
}
该函数只能在 TCP 服务器中使用,让服务器进入监听状态,等待远端的连接请求,LwIP 中可以接收多个客户端的连接,因此参数 backlog 指定了请求队列的大小,具体如下
#define listen(s,backlog) lwip_listen(s,backlog)
intlwip_listen(int s, int backlog);
参数 s 是表示要绑定的 Socket 套接字,注意了,这个套接字必须是从 socket() 函数中返回的索引,否则将无法完成绑定操作。
参数 backlog指定服务器可连接客户端的数量。
accept() 函数用于 TCP 服务器中,等待着远程主机的连接请求,并且建立一个新的 TCP 连接,在调用这个函数之前需要通过调用 listen() 函数让服务器进入监听状态。accept() 函数的调用会阻塞应用线程直至与远程主机建立 TCP 连接。同时函数返回一个 int 类型的套接字描述符,根据它能索引到连接结构,如果连接失败则返回-1,具体如下
#define accept(s,addr,addrlen) lwip_accept(s,addr,addrlen)
int lwip_accept(int s,struct sockaddr *addr,socklen_t *addrlen)
参数 s 是表示要绑定的 Socket 套接字,注意了,这个套接字必须是从 socket() 函数中返回的索引,否则将无法完成绑定操作。
参数 addr 是一个返回结果参数,其实就是远程主机的地址与端口号等信息,当新的连接已经建立后,远端主机的信息将保存在连接句柄中,它能够唯一的标识某个连接对象。
看名字就知道,这个函数是用于设置套接字的一些选项的,参数 level 有多个常见的选项,如:
• SOL_SOCKET:表示在 Socket 层。
• IPPROTO_TCP:表示在 TCP 层。
• IPPROTO_IP:表示在 IP 层。
参数 optname 表示该层的具体选项名称,比如:
#define setsockopt(s,level,optname,opval,optlen) \
lwip_setsockopt(s,level,optname,opval,optlen)
int
lwip_setsockopt(int s,
int level,
int optname,
const void *optval,
socklen_t optlen)