超级好用的C++实用库之套接字

简介: 超级好用的C++实用库之套接字

概述

C++中的Socket编程是实现网络通信的基础,允许程序通过网络与其他程序交换数据。但Socket编程在Windows和Linux系统上存在一些差异,主要包括如下几点。

1、Linux涉及网络编程的头文件主要为<sys/socket.h>、<netinet/in.h>、<arpa/inet.h>,Windows上的头文件主要为<winsock2.h>。

2、Linux不需要显式初始化和清理操作,Windows需要使用WSAStartup和WSACleanup进行显式初始化和清理操作。

3、Linux通常使用perror()或检查返回值,错误码直接从系统调用返回。Windows一般使用WSAGetLastError()获取错误码,并通过WSASetLastError()设置错误码。

4、Linux使用标准的POSIX数据类型,比如:socklen_t。Windows需要使用特定的类型,比如用SOCKET代替int作为套接字描述符。

新手对以上这些差异不熟悉的话,往往会遇到各种各样的问题。另外,阻塞与非阻塞方式发送和接收数据,接口的使用方式也是完全不一样的。为了屏蔽这些差异,并提供更加易用的接口,我们封装了CHP_Socket类。

CHP_Socket

CHP_Socket类是一个接口类,不需要实例化。因此,我们将构造函数和析构函数声明成了私有的,并提供了若干实用的静态函数。这些静态函数涵盖全局初始化、全局清理、初始化TCP套接字、非阻塞连接、非阻塞发送、非阻塞接收等各种操作。

CHP_Socket类的头文件,可参考下面的示例代码。

#pragma once

#ifdef _WIN32
        #include <winsock2.h>
#else
        #include <unistd.h>
#endif

#include "HP_Types.h"

#define HP_SOCKET_E_GENERAL                           -1
#define HP_SOCKET_E_NOROUTE                           -2
#define HP_SOCKET_E_UNREACHABLE                       -3
#define HP_SOCKET_E_NOSERVER                          -4
#define HP_SOCKET_E_TIMEOUT                           -5
#define HP_SOCKET_E_WOULDBLOCK                        1
#define HP_SOCKET_E_ATLEAST_ONE_BYTE                  2

#ifdef _WIN32
        #define  HP_SOCKET_INVALID_HANDLE             INVALID_SOCKET
        typedef SOCKET HP_SOCKET;
#else
        #define  HP_SOCKET_INVALID_HANDLE             -1
        typedef int HP_SOCKET;
#endif

class CHP_Socket
{
public:
        static int Startup();

        static int Cleanup();

        static HP_SOCKET InitTcp(unsigned int uiRecvBufSize = 0, unsigned int uiSendBufSize = 0, bool bNoBlock = true);

        static HP_SOCKET InitUdp(unsigned int uiRecvBufSize = 0, unsigned int uiSendBufSize = 0, bool bNoBlock = true);

        static void Deinit(HP_SOCKET &sock);

        static int SetLinger(HP_SOCKET sock, bool bLinger, unsigned int uiTimeoutSec);

        static int EnableNoBlock(HP_SOCKET sock, bool bEnable = true);

        static int EnableReuseAddr(HP_SOCKET sock, bool bEnable = true);

        static int EnableBroadcast(HP_SOCKET sock, bool bEnable = true);

        static int SetOption(HP_SOCKET sock, int nOptionName, char *pOption, int nOptionLen);

        static int GetOption(HP_SOCKET sock, int nOptionName, char *pOption, int &nOptionLen);

        static int Bind(HP_SOCKET sock, unsigned int uiIP, unsigned short usPort);

        static int Bind(HP_SOCKET sock, const char *pszIP, unsigned short usPort);

        static int Listen(HP_SOCKET sock, int nListenNum);

        static int Accept(HP_SOCKET sock, HP_SOCKET &sockNew);

        static int Connect(HP_SOCKET sock, unsigned int uiIP, unsigned short usPort);

        static int Connect(HP_SOCKET sock, const char *pszIP, unsigned short usPort);

        static int ProbeConnect(HP_SOCKET sock);

        static int TcpSendSingle(HP_SOCKET sock, char *pBuf, int &nBufLen);

        static int TcpSendWhole(HP_SOCKET sock, char *pBuf, int nTotalLen, int &nSendedLen);

        static int TcpSendTimeout(HP_SOCKET sock, char *pBuf, int nBufLen, unsigned int uiTimeoutSec);

        static int TcpRecvSingle(HP_SOCKET sock, char *pBuf, int &nBufLen);

        static int TcpRecvWhole(HP_SOCKET sock, char *pBuf, int nTotalLen, int &nRecvedLen);

        static int TcpRecvWholeUntilKey(HP_SOCKET sock, char *pBuf, int nTotalLen, int &nRecvedLen, const char *pszKey);

        static int TcpRecvTimeout(HP_SOCKET sock, char *pBuf, int nBufLen, unsigned int uiTimeoutSec);

        static int UdpSend(HP_SOCKET sock, char *pBuf, int &nBufLen, unsigned int uiIP, unsigned short usPort);

        static int UdpSend(HP_SOCKET sock, char *pBuf, int &nBufLen, const char *pszIP, unsigned short usPort);

        static int UdpRecv(HP_SOCKET sock, char *pBuf, int &nBufLen, unsigned int &uiIP, unsigned short &usPort);

        static int UdpRecv(HP_SOCKET sock, char *pBuf, int &nBufLen, char pszIP[16], unsigned short &usPort);

        static int GetRemoteAddr(HP_SOCKET sock, unsigned int &uiIP, unsigned short &usPort);

        static int GetRemoteAddr(HP_SOCKET sock, char pszIP[16], unsigned short &usPort);

        static int GetLocalAddr(HP_SOCKET sock, unsigned int &uiIP, unsigned short &usPort);

        static int GetLocalAddr(HP_SOCKET sock, char pszIP[16], unsigned short &usPort);

        static char *IPUintToStr(unsigned int uiIP, char pszIP[16]);

        static unsigned int IPStrToUint(const char *pszIP);

        static unsigned short HostToNetwork(unsigned short usValue);

        static unsigned int HostToNetwork(unsigned int uiValue);

        static HP_U64 HostToNetwork(HP_U64 ui64Value);

        static unsigned short NetworkToHost(unsigned short usValue);

        static unsigned int NetworkToHost(unsigned int uiValue);

        static HP_U64 NetworkToHost(HP_U64 ui64Value);

        static int BindDevice(HP_SOCKET sock, const char *pszNetName = "eth0");

private:
        static int SetRecvBufSize(HP_SOCKET sock, unsigned int uiSize);
        static int SetSendBufSize(HP_SOCKET sock, unsigned int uiSize);
        static int PasreErrorCode(int nErrorCode);
        static int Select(HP_SOCKET sock, unsigned int uiTimeoutSec, bool bCheckWrite);

private:
        CHP_Socket();
        ~CHP_Socket();
};

在头文件的开头部分,我们定义几个错误码。其中,小于0的值表示遇到了错误,大于0的值表示非阻塞模式下未发送完或接收完所有数据。各个错误码具体的含义如下。

HP_SOCKET_E_GENERAL:通用错误。

HP_SOCKET_E_NOROUTE:网络不可达。

HP_SOCKET_E_UNREACHABLE:主机不可达。

HP_SOCKET_E_NOSERVER:服务器拒绝。

HP_SOCKET_E_TIMEOUT:连接超时或收发数据超时。

HP_SOCKET_E_WOULDBLOCK:未连接上,需要继续等待;或未收到数据,需要继续等待;或数据未发送出去,需要继续等待。

HP_SOCKET_E_ATLEAST_ONE_BYTE:收到或者发送了至少一个字节的数据。

接下来,我们将详细介绍CHP_Socket类导出的公共接口。

Startup:全局初始化,应用层在程序开始调用一次即可。返回值为0表示成功,其他为错误码。

Cleanup:全局清理,应用层在程序结束调用一次即可。返回值为0表示成功,其他为错误码。

InitTcp:初始化TCP套接字。参数uiRecvBufSize为接收缓冲区大小,单位为B,传0默认为8KB。参数uiSendBufSize为发送缓冲区大小,单位为B,传0默认为8KB。参数bNoBlock表示是否设置非阻塞模式。成功返回套接字,失败返回HP_SOCKET_INVALID_HANDLE。

InitUdp:初始化UDP套接字,参数与返回值的含义同上。

Deinit:释放socket。参数sock为待释放的套接字,可以是TCP套接字,也可以是UDP套接字。

SetLinger:设置socket的SO_LINGER参数(Windows不支持该接口,会直接返回错误)。参数sock为需要设置的套接字,参数bLinger表示是否启用延迟关闭,参数uiTimeoutSec为延迟关闭的时间,单位为秒。返回值为0表示成功,其他为错误码。

EnableNoBlock:使能socket的非阻塞模式。参数sock为需要设置的套接字,参数bEnable表示是否使能非阻塞模式。返回值为0表示成功,其他为错误码。

EnableReuseAddr:使能socket重复绑定。参数sock为需要设置的套接字,参数bEnable表示是否使能重复绑定。返回值为0表示成功,其他为错误码。

EnableBroadcast:使能socket发送广播信息。参数sock为需要设置的套接字,参数bEnable表示是否使能发送广播信息。返回值为0表示成功,其他为错误码。

SetOption:调用setsockopt设置socket的SOL_SOCKET选项。参数sock为需要设置的套接字,参数snOptionName为选项名称,具体参考setsockopt的optname参数定义。参数pOption为选项值内容,具体参考setsockopt的optvalue参数定义。参数nOptionLen为选项值内容长度,具体参考setsockopt的optlen参数定义。返回值为0表示成功,其他为错误码。

GetOption:调用getsockopt获取socket的SOL_SOCKET选项,参数与返回值的含义同上。

Bind:绑定socket的本地地址。参数sock为需要设置的套接字,参数uiIP或pszIP为绑定的IP地址(网络字节序整数或字符串),参数usPort为绑定的端口。返回值为0表示成功,其他为错误码。

Listen:监听socket的连接。参数sock为需要设置的套接字,参数nListenNum为请求队列的最大连接数。返回值为0表示成功,其他为错误码。

Accept:接受客户端的连接请求。参数sock为已经监听的套接字,参数sockNew为请求连接的客户端套接字,用于传出。返回值为0表示成功,其他为错误码。

Connect:连接指定的服务器地址。参数sock为需要连接的套接字,参数uiIP或pszIP为需要连接的服务器IP地址(网络字节序整数或字符串),参数usPort为需要连接的服务器端口。返回值为0表示连接成功,HP_SOCKET_E_WOULDBLOCK表示正在连接,需要调用ProbeConnect不断探测,其他为错误码。

ProbeConnect:非阻塞模式下探测连接服务器是否成功。参数sock为需要探测连接的套接字。返回值为0表示连接成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续探测,其他为错误码。

TcpSendSingle:TCP连接发送数据。参数sock为需要发送数据的套接字,参数pBuf为需要发送的数据,参数nBufLen传入时为需要发送数据的长度,传出时为已经发送的数据长度。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续发送,其他为错误码。

TcpSendWhole:tcp连接发送数据,可以从上次已发送的位置继续发送数据。参数sock为需要发送数据的套接字,参数pBuf为需要发送的数据,参数nTotalLen为需要发送数据的总长度,参数nSendedLen传入时为已经发送数据的长度,传出时为最新已经发送的数据长度。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续发送,HP_SOCKET_E_ATLEAST_ONE_BYTE表示发送了至少一个字节的数据,也需要继续发送,其他为错误码。

TcpSendTimeout:TCP连接在指定的超时时间内发送数据。参数sock为需要发送数据的套接字,参数pBuf为需要发送的数据,参数nBufLen为需要发送数据的长度,参数uiTimeoutSec为指定的超时时间,单位为秒。返回值为0表示成功,其他为错误码。

TcpRecvSingle:TCP连接接收数据。参数sock为需要接收数据的套接字,参数pBuf为接收数据的缓存,参数nBufLen传入时为需要接收的数据长度,传出时为已经接收到数据的长度。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续接收,其他为错误码。

TcpRecvWhole:TCP连接接收数据,可以从上次已接收的位置继续接收数据。参数sock为需要接收数据的套接字,参数pBuf为接收数据的缓存,参数nTotalLen为接收数据的总长度,参数nRecvedLen传入时为缓存中已经接收的数据长度,传出时为最新已经接收的数据长度。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续接收,HP_SOCKET_E_ATLEAST_ONE_BYTE表示收到了至少一个字节的数据,也需要继续接收,其他为错误码。

TcpRecvWholeUntilKey:TCP连接接收数据直到指定的字符串为止。参数sock为需要接收数据的套接字,参数pBuf为接收数据的缓存,参数nTotalLen为接收数据的总长度,参数nRecvedLen传入时为缓存中已经接收的数据长度,传出时为最新已经接收的数据长度,参数pszKey为指定的结束字符串,一般用于接收指定的边界。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续接收,HP_SOCKET_E_ATLEAST_ONE_BYTE表示收到了至少一个字节的数据,也需要继续接收,其他为错误码。

TcpRecvTimeout:TCP连接在指定的超时时间内接收数据。参数sock为需要接收数据的套接字,参数pBuf为接收数据的缓存,参数nBufLen为接收数据的长度,参数uiTimeoutSec为指定的超时时间,单位为秒。返回值为0表示成功,其他为错误码。

UdpSend: UDP连接发送数据。参数sock为需要发送数据的套接字,参数pBuf为需要发送的数据,参数nBufLen为传入需要发送数据的长度,返回已经发送数据的长度,参数uiIP或pszIP为发送目标的IP地址(网络字节序整数或字符串),参数usPort为发送目标的端口。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续发送,其他为错误码。

UdpRecv:UDP连接接收数据。参数sock为需要接收数据的套接字,参数pBuf为接收数据的缓存,参数nBufLen传入时为需要接收的数据长度,传出时为已经接收到数据的长度。参数uiIP或pszIP返回接收数据的来源IP地址(网络字节序整数或字符串),参数usPort返回接收数据的来源端口。返回值为0表示成功,HP_SOCKET_E_WOULDBLOCK表示需要等会继续接收,其他为错误码。

GetRemoteAddr:获取套接字的对端IP地址和端口。参数sock为需要获取的套接字,参数uiIP或pszIP表示返回的IP地址(网络字节序整数或字符串),参数usPort表示返回的端口。返回值为0表示成功,其他为错误码。

GetLocalAddr:获取套接字本地绑定的IP地址和端口,参数与返回值的含义同上。

IPUintToStr:将整数型IP地址(网络字节序)转换成字符串型IP地址。参数uiIP为整数型IP地址(网络字节序),参数pszIP为字符串型IP地址,用于传出。返回值为字符串型IP地址,非NULL表示成功,否则失败。

IPStrToUint:将字符串型IP地址转换成整数型IP地址(网络字节序)。参数pszIP为字符串型IP地址,返回值为整数型IP地址(网络字节序),非0表示成功,否则失败。

HostToNetwork:将主机字节序转换成网络字节序,可以是16位无符号整数、32位无符号整数、64位无符号整数。

NetworkToHost:将网络字节序转换成主机字节序,可以是16位无符号整数、32位无符号整数、64位无符号整数。

BindDevice:将套接字绑定到某个设备(该接口仅对Linux有效),该接口一般用于多卡绑定同时发送数据。参数sock为套接字,参数pszNetName为设备的网卡接口名称,默认为"eth0"。返回值为0表示成功,其他为错误码。


总结

Socket编程是实现网络间进程通信的基础技术之一,掌握它等于掌握了网络通信的“语言”。无论是简单的数据传输、文件共享,还是复杂的分布式系统构建,Socket都是不可或缺的知识点。了解Socket编程的底层机制,有助于开发者对网络应用的性能瓶颈进行定位和优化,比如:通过调整缓冲区大小、使用非阻塞IO或异步IO模型等方式提升数据传输效率。


相关文章
|
2月前
|
算法 C++ 容器
C++标准库(速查)总结
C++标准库(速查)总结
79 6
|
2月前
|
存储 算法 C++
C++ STL 初探:打开标准模板库的大门
C++ STL 初探:打开标准模板库的大门
112 10
|
2月前
|
存储 程序员 C++
C++常用基础知识—STL库(2)
C++常用基础知识—STL库(2)
79 5
|
2月前
|
存储 自然语言处理 程序员
C++常用基础知识—STL库(1)
C++常用基础知识—STL库(1)
70 1
|
3月前
|
编译器 API C语言
超级好用的C++实用库之跨平台实用方法
超级好用的C++实用库之跨平台实用方法
44 6
|
3月前
|
安全 C++
超级好用的C++实用库之环形内存池
超级好用的C++实用库之环形内存池
65 5
|
3月前
|
存储 算法 安全
超级好用的C++实用库之sha256算法
超级好用的C++实用库之sha256算法
129 1
|
3月前
|
存储 算法 安全
超级好用的C++实用库之国密sm4算法
超级好用的C++实用库之国密sm4算法
92 0
|
3月前
|
网络协议 Linux C++
超级好用的C++实用库之网络
超级好用的C++实用库之网络
64 0
|
3月前
|
算法 安全 Serverless
超级好用的C++实用库之国密sm3算法
超级好用的C++实用库之国密sm3算法
130 0