鸿蒙源码分析（五）

女爷i 2022-08-29 05:44 200阅读 0赞

# tcp\_socket.c代码分析 #

本篇主要分析模块一中trans\_service目录下tcp\_socket.c代码。  
文件路径（模块一\\communication\_softbus\_lite- master\\trans\_service\\source\\utils\\message.c）

## 一、背景知识 ##

**tcp\_soclet相关理论知识已经在上一篇博客中详细解释。**  
传送门：[点击查看tcp\_socket理论篇][tcp_socket]

## 二、代码分析 ##

**1. 相关宏定义**

#define SEND_BUF_SIZE 0x200000 //发送缓冲区的大小
    #define RECV_BUF_SIZE 0x100000 //接受缓冲区的大小
    #define USER_TIMEOUT_MS 5000 //用户暂停时间
    #define DEFAULT_SEND_TIMEOUT 200//默认的发送时间阈值

**2. 端口相关函数**  
**2.1 端口复用函数SetReuseAddr（int fd, int on）**  
参数详解：

*  fd ：对应的文件描述符
 *  on：对于setsockopt()，指向包含新选项值的缓冲。

static int SetReuseAddr(int fd, int on)
    { 
        int rc = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
        //setsockopt函数用来获取或者设置与某个套接字关联的选项。传入参数分别为
        //成功执行时候返回零，失败返回-1
        if (rc != 0) { 
            SOFTBUS_PRINT("[TRANS] SetReuseAddr fail\n");
            return -1;//setsockopt执行失败则函数推出并返回-1
        }
        return 0;
    }

**2.2 SetNoDelay(int fd, int on)**

static int SetNoDelay(int fd, int on)
    //tcp_nodelay该算法要求一个TCP连接上最多只能有一个未被确认的小分组，在该小分组的确认到来之前，不能发送其他小分组。
    { 
        int rc = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on));
    	//setsockopt函数用来获取或者设置与某个套接字关联的选项。传入参数分别为
        //成功执行时候返回零，失败返回-1
        if (rc != 0) { 
            SOFTBUS_PRINT("[TRANS] SetNoDelay fail\n");
            return -1;//setsockopt执行失败则函数推出并返回-1
        }
        return 0;
    }

**3. tcp\_server相关函数**  
**3.1 设置服务选项函数SetServerOption(int fd)**

static void SetServerOption(int fd)
    { 
        SetReuseAddr(fd, 1);
        SetNoDelay(fd, 1);
    }

**3.2打开服务器函数**  
这个函数OpenTcpServer(const char \*ip, uint16\_t port)传入ip和对应端口号来打开相关服务器。

sockaddr\_in是系统封装的一个结构体，具体包含了成员变量：sin\_family、sin\_addr、sin\_zero。

typedef struct sockaddr_in { 
     
    #if(_WIN32_WINNT < 0x0600)
        short   sin_family;
    #else //(_WIN32_WINNT < 0x0600)
        ADDRESS_FAMILY sin_family;
    #endif //(_WIN32_WINNT < 0x0600)
        USHORT sin_port;
        IN_ADDR sin_addr;
        CHAR sin_zero[8];
    } SOCKADDR_IN, *PSOCKADDR_IN;

sin\_family主要用来定义是哪种地址族  
sin\_port主要用来保存端口号  
sin\_addr主要用来保存IP地址信息  
sin\_zero没有特殊含义

int OpenTcpServer(const char *ip, uint16_t port)//传入端口和设备ip来打开tcp服务器
    { 
        if (ip == NULL) { 
            return -DBE_BAD_PARAM;//传入空ip的处理
        }
        struct sockaddr_in addr = { 0};
        errno = 0;
        int rc = inet_pton(AF_INET, ip, &addr.sin_addr);
        //IP地址转换函数，可以在将点分文本的IP地址转换为二进制网络字节序”的IP地址
        //转换成功返回值rc为正值，失败为非正
        if (rc <= 0) { 
            return -DBE_BAD_IP;
        }
        addr.sin_family = AF_INET;//指定IP地址地址版本人为IPV4
        addr.sin_port = htons(port);//存放端口信息
        errno = 0;
        int fd = socket(AF_INET, SOCK_STREAM, 0);//用来创建套接字
        //参数：地址族，数据传输类型，传输协议
        //返回值：执行成功返回非负值，执行失败返回一个负值
        if (fd < 0) { 
            return -DBE_OPEN_SOCKET;
        }
        SetServerOption(fd);//为刚创建的套接字执行服务器选项设置端口重用和弄nodelay
        errno = 0;
        rc = bind(fd, (struct sockaddr *)&addr, sizeof(addr));
        //当socket函数返回一个描述符时，只是存在于其协议族的空间中，并没有分配一个具体的协议地址（这里指IPv4/IPv6和端口号的组合），bind函数可以将一组固定的地址绑定到sockfd上。
        //返回值：执行成功返回0，失败返回-1
        if (rc < 0) { 
            ShutDown(fd);//执行失败就关闭套接字对应接口
            return -DBE_BIND_SOCKET;
        }
        return fd;//返回创建成功的套接字
    }

**3.3获取相关socket套接字对应端口号**  
getsockport函数用来获取socket套接字相关的端口，传入参数为套接字

int GetSockPort(int fd)//获取socket套接字相关的端口
    { 
        struct sockaddr_in addr;
        socklen_t addrLen = sizeof(addr);
        int rc = getsockname(fd, (struct sockaddr *)&addr, &addrLen);
        //getsockname可以获得一个与socket相关的地址，服务器端可以通过它得到相关客户端地址，而客户端也可以得到当前已连接成功的socket的ip和端口。
        if (rc != 0) { 
            return rc;
        }
        return ntohs(addr.sin_port);//作用是将一个16位数由网络字节顺序转换为主机字节顺序
    }

**4.数据传输相关函数**  
**4.1发送数据**  
TcpSendData(int fd, const char \*buf, int len, int timeout)函数基于send函数用来发送数据到tcp连接的另一端，返回值为发送的数据总数。  
**参数详解：**

*  fd：对应套接字
 *  buf：数据缓冲区
 *  len：传输尺度
 *  timeout：用来重置默认值

int TcpSendData(int fd, const char *buf, int len, int timeout)//发送数据到tcp连接的另一端
    { 
        if (fd < 0 || buf == NULL || len == 0) { 
            return -1;
        }//不满足发送条件时的错误信息和退出码
    
        if (timeout == 0) { //将传入的timeout零值置为默认值
            timeout = DEFAULT_SEND_TIMEOUT;
        }
    
        int32_t bytes = 0;
        while (true) { 
            errno = 0;
            if (bytes >= len || bytes < 0) { 
                break;
            }
            int32_t rc = send(fd, &buf[bytes], len - bytes, 0);//执行成功返回数据总数，否则为-1
            //不论是客户还是服务器应用程序都用send函数来向TCP连接的另一端发送数据。
            //客户程序一般用send函数向服务器发送请求，而服务器则通常用send函数来向客户程序发送应答。
            if ((rc == -1) && (errno == EAGAIN)) { //错误情况处理
                continue;
            } else if (rc <= 0) { 
                if (bytes == 0) { 
                    bytes = -1;
                }
                break;
            }
            bytes += rc;
            if (bytes == len) { 
                break;
            }
        }
        return bytes;//返回所传送的数据大小bytes
    }

**4.2接收数据函数**  
TcpRecvMessages(int fd, char \*buf, uint32\_t len, int timeout, int flags)基于recv函数从tcp连接的另一端接收数据，返回值为接收的数据总数。  
**参数详解：**

*  该函数的第一个参数指定接收端套接字描述符；
 *  第二个参数指明一个缓冲区，该缓冲区用来存放recv函数接收到的数据；
 *  第三个参数指明buf的长度；
 *  第四个参数一般重置超时阈值。
 *  第五个参数一般置0

static int32_t TcpRecvMessages(int fd, char *buf, uint32_t len, int timeout, int flags)//基于recv函数从tcp连接的另一端接收数据
    { 
        if (fd < 0 || buf == NULL || len == 0 || timeout < 0) { 
            return -1;
        }
        errno = 0;
        int32_t rc = recv(fd, buf, len, flags);//论是客户还是服务器应用程序都用recv函数从TCP连接的另一端接收数据。
        //该函数的第一个参数指定接收端套接字描述符；
        //第二个参数指明一个缓冲区，该缓冲区用来存放recv函数接收到的数据；
        //第三个参数指明buf的长度；
        //第四个参数一般置0。
        if ((rc == -1) && (errno == EAGAIN)) { //错误情况处理
            rc = 0;
        } else if (rc <= 0) { 
            rc = -1;
        }
        return rc;//rc为执行成功时候所接受的数据总量
    }
    int TcpRecvData(int fd, char *buf, int len, int timeout)//tcp协议中接受用户发送的数据包
    { 
        return TcpRecvMessages(fd, buf, len, timeout, 0);
    }

**5. 关闭连接的函数**  
**shutdown()** 库函数详解  
**函数声明：int shutdown(int sockfd,int how);**  
**参数：**

*  sockfd:要关闭的对印的描述符套接字
 *  how：是关闭的方式，详细描述见下方  
    how的方式有三种分别是  
    SHUT\_RD（0）：关闭sockfd上的读功能，此选项将不允许sockfd进行读操作。  
    SHUT\_WR（1）：关闭sockfd的写功能，此选项将不允许sockfd进行写操作。  
    SHUT\_RDWR（2）：关闭sockfd的读写功能。

成功则返回0，错误返回-1，  
**错误码errno：**

*  EBADF表示sockfd不是一个有效描述符；
 *  ENOTCONN表示sockfd未连接；
 *  ENOTSOCK表示sockfd是一个文件描述符而不是socket描述符。

void CloseFd(int fd)//用来关闭socket相关套接字接口
    { 
        if (fd >= 0) { 
    #if defined(__LITEOS_M__) || defined(__LITEOS_RISCV__)//基于鸿蒙内核和RISCV的条件编译
            closesocket(fd);
            //本函数关闭一个套接口。更确切地说，它释放套接口描述字s，以后对s的访问均以WSAENOTSOCK错误返回。若本次为对套接口的最后一次访问，则相应的名字信息及数据队列都将被释放。
    #else
            close(fd);//关闭本进程的socket id，但链接还是开着的，用这个socket id的其它进程还能用这个链接，能读或写这个socket id
    #endif
        }
    }
    void ShutDown(int fd)
    { 
        if (fd >= 0) { 
            SOFTBUS_PRINT("[TRANS] ShutDown fd=%d\n", fd);
            shutdown(fd, SHUT_RDWR);//函数解释和相关操作见上方
            CloseFd(fd);//关闭fd对应的套接口
        }
    }

以上为tcp\_socket.c文件全代码分析，相关理论基础：[tcp\_socket通信机制原理][tcp_socket]

[tcp_socket]: https://forum.trustie.net/forums/3397/detail