README.md
1# BearPi-HM_Nano开发板WiFi编程开发——TCP服务器
2本示例将演示如何在BearPi-HM_Nano开发板上使用socket编程创建TCP服务端,接收客户端消息并回复固定消息。
3
4
5## socket API分析
6本案例主要使用了以下几个API来完成TCP Server的编程实验。
7### socket()
8
9```c
10sock_fd = socket(AF_INET, SOCK_STREAM, 0)) //AF_INT:ipv4, SOCK_STREAM:tcp协议
11```
12**描述:**
13
14在网络编程中需要进行的第一件事情就是创建一个socket,无论是客户端还是服务器端,都需要创建一个socket。该函数返回socket文件描述符,类似于文件描述符。socket是一个结构体,被创建在内核中。
15### bind()
16```c
17bind(sockfd, (struct sockaddr*)&server_sock, sizeof(server_sock))
18```
19**描述:**
20
21把一个本地协议地址和socket绑定,比如把本机的2222端口绑定到socket。注意:在客户端不需要调用bind函数,这是因为如果没有调用bind函数绑定一个端口的话,当调用connect函数时,内核会为该socket临时分配一个端口。因为所有客户端都需要知道服务器使用的是哪个端口,所以在服务器侧需要提前绑定确定的端口号。
22
23
24### listen()
25```c
26int listen(int s, int backlog)
27```
28**描述:**
29
30当socket创建后,它通常被默认为是主动套接字,即默认要马上调用connect函数的,而作为服务器是需要被动接收的,所以需要调用listen函数将主动套接字转换成被动套接字。调用listen函数后,内核将从该socket接收连接请求。
31
32
33### accept()
34```c
35int accept(s, addr, addrlen)
36```
37**描述:**
38
39此函数返回已经完成连接的socket。注意:此处的socket不同于服务器开始时创建的监听socket,此socket是已经完成连接的套接字,监听socket只是用来监听。
40
41### recv()
42```c
43int recv(SOCKET s, char *buf, int len, int flags)
44```
45**描述:**
46
47recv函数用来从已建立TCP连接的另一端接收数据。
48
49### send()
50```c
51int send(SOCKET s, char *buf, int len, int flags)
52```
53**描述:**
54
55send函数用来向已建立TCP连接的另一端发送数据。
56
57
58## 软件设计
59
60**主要代码分析**
61
62完成TCP server的建立及收发功能实现需要以下几步:
63
641. 通过 `socket` 接口创建一个socket,`AF_INT`表示ipv4,`SOCK_STREAM`表示使用tcp协议。
652. 调用 `bind` 接口绑定socket和地址。
663. 调用 `listen` 接口监听指定port,通知操作系统去接收来自客户端的连接请求,第二个参数:指定队列长度。
674. 调用`accept`接口从队列中获得一个客户端的连接请求。
685. 调用 `recv` 接口接收客户端发来的数据。
696. 调用 `send` 接口向客户端回复固定的数据。
70
71```c
72static void TCPServerTask(void)
73{
74 //在sock_fd 进行监听,在 new_fd 接收新的链接
75 int sock_fd, new_fd;
76
77 //服务端地址信息
78 struct sockaddr_in server_sock;
79
80 //客户端地址信息
81 struct sockaddr_in client_sock;
82 int sin_size;
83
84 struct sockaddr_in *cli_addr;
85
86 //连接Wifi
87 WifiConnect(CONFIG_WIFI_SSID, CONFIG_WIFI_PWD);
88
89 //创建socket
90 if ((sock_fd = socket(AF_INET, SOCK_STREAM, 0)) == -1) {
91 perror("socket is error\r\n");
92 exit(1);
93 }
94
95 bzero(&server_sock, sizeof(server_sock));
96 server_sock.sin_family = AF_INET;
97 server_sock.sin_addr.s_addr = htonl(INADDR_ANY);
98 server_sock.sin_port = htons(CONFIG_CLIENT_PORT);
99
100 //调用bind函数绑定socket和地址
101 if (bind(sock_fd, (struct sockaddr *)&server_sock, sizeof(struct sockaddr)) == -1) {
102 exit(1);
103 }
104
105 //调用listen函数监听(指定port监听)
106 if (listen(sock_fd, TCP_BACKLOG) == -1) {
107 exit(1);
108 }
109
110 printf("start accept\n");
111
112 //调用accept函数从队列中
113 while (1) {
114 sin_size = sizeof(struct sockaddr_in);
115
116 if ((new_fd = accept(sock_fd, (struct sockaddr *)&client_sock, (socklen_t *)&sin_size)) == -1) {
117 perror("accept");
118 continue;
119 }
120
121 cli_addr = malloc(sizeof(struct sockaddr));
122
123 printf("accept addr\r\n");
124
125 if (cli_addr != NULL) {
126 int ret = memcpy_s(cli_addr, sizeof(cli_addr), &client_sock, sizeof(struct sockaddr));
127 if (!ret) {
128 perror("memcpy is error\r\n");
129 exit(1);
130 }
131 }
132 //处理目标
133 ssize_t ret;
134
135 while (1) {
136 memset_s(recvbuf, sizeof(recvbuf), 0, sizeof(recvbuf));
137 if ((ret = recv(new_fd, recvbuf, sizeof(recvbuf), 0)) == -1) {
138 printf("recv error \r\n");
139 }
140 printf("recv :%s\r\n", recvbuf);
141 sleep(TASK_DELAY_2S);
142 if ((ret = send(new_fd, buf, strlen(buf) + 1, 0)) == -1) {
143 perror("send : ");
144 }
145 sleep(TASK_DELAY_2S);
146 }
147 close(new_fd);
148 }
149}
150```
151
152## 编译调试
153
154### 修改 BUILD.gn 文件
155
156修改 `device\board\bearpi\bearpi_hm_nano\app` 路径下 BUILD.gn 文件,指定 `tcp_server` 参与编译。
157```r
158#"D1_iot_wifi_sta:wifi_sta",
159#"D2_iot_wifi_sta_connect:wifi_sta_connect",
160#"D3_iot_udp_client:udp_client",
161"D4_iot_tcp_server:tcp_server",
162#"D5_iot_mqtt:iot_mqtt",
163#"D6_iot_cloud_oc:oc_mqtt",
164```
165
166
167### 运行结果
168
169示例代码编译烧录后,按下开发板的RESET按键,通过串口助手查看日志,会打印模块的本地IP,如本例程中的 `192.168.0.164` ,并开始准备获取客户端的请求链接。
170```
171g_connected: 1
172netifapi_dhcp_start: 0
173server :
174 server_id : 192.168.0.1
175 mask : 255.255.255.0, 1
176 gw : 192.168.0.1
177 T0 : 7200
178 T1 : 3600
179 T2 : 6300
180clients <1> :
181 mac_idx mac addr state lease tries rto
182 0 181131a48f7a 192.168.0.164 10 0 1 2
183netifapi_netif_common: 0
184start accept
185```
186使用 Socket tool 创建客户端用于测试,如下图所示。
187
188
189
190在创建客户端后点击“连接”,在数据发送窗口输入要发送的数据,点击发送后服务端会回复固定消息,如下图所示,且开发板收到消息后会通过日志打印出来。
191
192```
193start accept
194accept addr
195recv :Hello! BearPi-HM_nano TCP Server!
196```
197
198