QTcpServer：使用自定义选项绑定套接字

Posted 2023-02-16

【中文标题】QTcpServer：使用自定义选项绑定套接字

【英文标题】：QTcpServer: bind socket with custom options

【发布时间】：2019-01-16 12:05:37

【问题描述】：

所以，这里有一些复杂的客户端-服务器应用程序，其中的一部分打开端口用于侦听和进一步的网络交互。使用了QTcpServer + QTcpSocket（后面会详细介绍）。

应用程序的这个“网络层”在任何地方都能正常工作，除了 Windows 8.1 Pro。只是不要问，为什么我们的客户端决定它可以用作服务器......它发生了，错误地重新启动进程，在特定端口上打开 TCP 连接以进行监听，有时会导致该端口不适合任何后续尝试绑定它。它看起来像某种魔法，但行为发生如下：

端口 8554 已被进程监听（“连接 -- 已建立”） 通过此套接字连接客户端时进程崩溃或以某种方式终止 进程重新启动并尝试再次侦听端口。失败并显示“已在使用”。 我停止服务器并尝试通过netstat -an 检查端口。它是免费的。

我等了一会儿，尝试通过powershell检查端口，比如：

$Listener = [System.Net.Sockets.TcpListener]8554
$Listener.Start()

不，这会导致类似“已在使用”这样的错误。

我可以将套接字绑定到另一个端口，powershell sn-p 也适用于它们。但是我们服务器的紧急重启也会“破坏”它们，场景是一样的。 一旦端口“损坏”，Windows 重新启动是解决此问题的唯一方法。 绑定到“任何地址”，即0.0.0.0:8554 的行为与所述相同。绑定到确切的 IP，比如10.11.12.123:8554 更好，在尝试将 FileZilla 绑定到“损坏的端口”时检查它。

现在是编码问题。至少在我们的架构中，为绑定提供精确的 IP 看起来是个坏主意，所以我决定在 Windows 上使用 SO_REUSEADDR。但是看起来我必须在 before 绑定/侦听调用之前设置此选项，这会导致显着的 QTcpServer 使用自定义。请记住，该应用程序是跨平台的（WinSock + sys/socket + 一些#defines，如果要使用 Qt 方法以外的东西......）。 Aaaand 还有我最喜欢的QTcpServer 自定义的旧版本，看看：

QTcpServer2.h

#pragma once

#include <QTcpServer>
#include <QMutex>

class QTcpServer2 : public QTcpServer

  QMutex         mConnectionMutex;
  QList<qintptr> mSocketDescriptors;

private:
  virtual void incomingConnection(qintptr socketDescriptor) override;

public:
  bool TakeIncomingSocketDescription(qintptr& socketDescriptor);

public:
  QTcpServer2();
;

QTcpServer2.cpp

#include <QMutexLocker>

#include "QTcpServer2.h"

void QTcpServer2::incomingConnection(qintptr socketDescriptor)

  QMutexLocker lock(&mConnectionMutex);
  mSocketDescriptors.append(socketDescriptor);


bool QTcpServer2::TakeIncomingSocketDescription(qintptr& socketDescriptor)

  QMutexLocker lock(&mConnectionMutex);
  if (mSocketDescriptors.empty()) 
    return false;
  
  socketDescriptor = mSocketDescriptors.takeFirst();
  return true;


QTcpServer2::QTcpServer2()
 

用法：

bool NetServer::DoInitConnection()

  mNetServer = QSharedPointer<QTcpServer2>(new QTcpServer2);
  if (!mNetServer->listen(QHostAddress::AnyIPv4, mPort)) 
    Log.Fatal(QString("Listen port fail (port: %1)").arg(mPort), true);
    return false;
  
  return true;

叹息... 是的，我知道挂起的连接机制，关于信号槽的想法，但现在没有代码了。 TakeIncomingSocketDescription 用于在某处传递套接字描述符。和线程访问，是的。无论如何，这段......代码需要重构，我非常需要你的建议：在这里自定义套接字绑定的适当方法是什么？假设子类化仍然存在，描述符列表也不是 -很容易摆脱。

Qt Sources 向我展示了以下内容：

/*! \internal
*/
void QTcpServerPrivate::configureCreatedSocket()

#if defined(Q_OS_UNIX)
    // Under Unix, we want to be able to bind to the port, even if a socket on
    // the same address-port is in TIME_WAIT. Under Windows this is possible
    // anyway -- furthermore, the meaning of reusable on Windows is different:
    // it means that you can use the same address-port for multiple listening
    // sockets.
    // Don't abort though if we can't set that option. For example the socks
    // engine doesn't support that option, but that shouldn't prevent us from
    // trying to bind/listen.
    socketEngine->setOption(QAbstractSocketEngine::AddressReusable, 1);
#endif

这正是我想要的，但无法从 Qt 类接口访问这些内部结构。 QTcpServer 隐式执行bind 调用，所以我不能在那里传递QAbstractSocket::ReuseAddressHint。

可能有一些巧妙的解决方案，也可能没有。如果有任何想法，我将不胜感激。

【问题讨论】：

Win 8.1 Pro 是否实现了POSIX.1-2001 层？如果是这样，调用::setsockopt(mNetServer.socketDescriptor(), SOL_SOCKET, SO_REUSEADDR, ...) 应该可以解决问题，并且应该可以跨大多数操作系统移植。

@G.M.，也许我错了，但是 socketDescriptor 是在listen() 中隐式设置或在setSocketDescriptor() 中显式设置的，它必须处于“监听”状态。你的意思是我必须自己实现一切——配置、绑定和监听套接字？ оО

【参考方案1】：

我花了一些时间来考虑所有可能的解决方案，尽管根本没有很多。

Here 我发现了一些看起来很像我的问题的东西。对代码进行了改编，在那里提供...好吧，只是从那个答案中提取了大部分内容=） @G.M. 的评论让我想到，在这种情况下，socket api 应该只在标头上有所不同

手册告诉我 SO_LINGER 标志通常是由于架构不好（在大多数情况下客户端应该关闭连接，而不是服务器），经过几次实验后发现这个标志并没有多大用处就我而言。

绑定到确切的 IP 会导致一些复杂性，恕我直言，这更像是一个拐杖而不是解决方案。

所以，经过小的修改，socket 监听类变成了这样：

QTcpServer2.h

#pragma once

#include <QTcpServer>
#include <QMutex>

class QTcpServer2 : public QTcpServer

  QMutex            mConnectionMutex;
  QList<qintptr>    mSocketDescriptors;
  const int         mPort;
  bool              mConnectionSuccessful;

private:
  /*override */virtual void incomingConnection(qintptr socketDescriptor) Q_DECL_OVERRIDE;

public:
  bool TakeIncomingSocketDescription(qintptr& socketDescriptor);

  bool isConnectionSuccessfull() const
   return mConnectionSuccessful; 

public:
  QTcpServer2(int port);
;

QTcpServer.cpp

#include "QTcpServer2.h"

#include <QMutexLocker>

#ifdef Q_OS_WIN
    #include <Windows.h>
    #pragma comment(lib, "ws2_32.lib")
#endif

#ifdef Q_OS_LINUX
    #include <sys/socket.h>
    #include <netinet/in.h>
    #include <netinet/tcp.h>
#endif

void QTcpServer2::incomingConnection(qintptr socketDescriptor)

    QMutexLocker lock(&mConnectionMutex);
    mSocketDescriptors.append(socketDescriptor);


bool QTcpServer2::TakeIncomingSocketDescription(qintptr& socketDescriptor)

    QMutexLocker lock(&mConnectionMutex);
    if (mSocketDescriptors.empty()) 
        return false;
    
    socketDescriptor = mSocketDescriptors.takeFirst();
    return true;


QTcpServer2::QTcpServer2(int port)
    : QTcpServer()
    , mPort(port)
    , mConnectionSuccessful(false)

    // open server and listen on given port
    int sockfd = 0;
    struct sockaddr_in serv_addr;
    memset(&serv_addr, 0, sizeof(serv_addr));

    sockfd = ::socket(AF_INET, SOCK_STREAM, 0);
    if(sockfd < 0)
    
        qDedug() << "QTcpServer2: socket couldn't be opened successfully!";
        return; //RET
    

#ifdef Q_OS_WIN
    // Not required in Linux, won't make any good 
    int flag = 1;
    if(::setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, reinterpret_cast<char*>(&flag), sizeof(int)) < 0)
    
        qDedug() << "QTcpServer2: Can't set SO_REUSEADDR";
        return; //RET
    
#endif

    //set Address,IFace, Port...
    serv_addr.sin_family = AF_INET;
    serv_addr.sin_addr.s_addr = INADDR_ANY;
    serv_addr.sin_port = htons(static_cast<ushort>(mPort));


    if (::bind(sockfd, (struct sockaddr *) &serv_addr, sizeof(sockaddr_in)) < 0)
    
        qDedug() << "QTcpServer2: can't bind socket" ;
        return; //RET
    

    if(::listen(sockfd, SOMAXCONN) < 0)
    
        qDedug() << "QTcpServer2: can't listen on port";
        return; //RET
    

    //forward our descriptor with SO_REUSEPORT to QTcpServer member
    setSocketDescriptor(sockfd);
    mConnectionSuccessful = true;
    qDedug() << "QTcpServer2: socket success =)";

只要“神奇的套接字问题”仅出现在 Windows 8.1 上，#define 就会使 SO_REUSEADDR 仅在 Windows 上使用。在 Linux 上 Qt 已经自行设置了这个标志（如问题所示），所以这个小补丁只改进了 Windows 行为以匹配所需的行为，在 Linux 上提供没有问题。

希望在其他平台上不需要这样的东西。