QLocalServer Class

成员函数文档

[explicit] QLocalServer::QLocalServer(QObject *parent = nullptr)

使用给定的parent 创建一个新的本地套接字服务器。

另请参阅 listen()。

[virtual noexcept] QLocalServer::~QLocalServer()

销毁QLocalServer 对象。如果服务器正在监听连接，则会自动关闭该连接。

在删除服务器之前，任何仍处于连接状态的客户端 QLocalSockets 必须断开连接或重新绑定到其他父对象。

另请参阅 close()。

[protected, since 6.8] void QLocalServer::addPendingConnection(QLocalSocket *socket)

该函数由QLocalServer::incomingConnection()调用，用于将socket 添加到待处理传入连接列表中。

该函数在 Qt 6.8 中引入。

另请参阅 incomingConnection() 和newConnection()。

void QLocalServer::close()

停止监听传入连接。现有连接不受影响，但任何新连接都将被拒绝。

另请参阅 isListening() 和listen()。

QString QLocalServer::errorString() const

返回与serverError() 报告的当前错误相对应的、易于理解的错误信息。如果没有合适的字符串，则返回空字符串。

另请参阅 serverError()。

QString QLocalServer::fullServerName() const

返回服务器正在监听的完整路径。

注意：此函数因平台而异

另请参阅 listen() 和serverName()。

[virtual] bool QLocalServer::hasPendingConnections() const

如果服务器有待处理的连接，则返回true ；否则返回false 。

另请参阅 nextPendingConnection() 和setMaxPendingConnections()。

[virtual protected] void QLocalServer::incomingConnection(quintptr socketDescriptor)

当有新连接可用时，QLocalServer 会调用此虚拟函数。socketDescriptor 是已接受连接的原生套接字描述符。

基础实现会创建一个QLocalSocket 对象，设置套接字描述符，然后将QLocalSocket 存储到待处理连接的内部列表中。最后触发newConnection() 事件。

重写此函数可更改服务器在有可用连接时的行为。

另请参阅 newConnection()、nextPendingConnection() 和QLocalSocket::setSocketDescriptor()。

bool QLocalServer::isListening() const

如果服务器正在监听传入连接，则返回true ；否则返回false 。

另请参阅 listen() 和close()。

bool QLocalServer::listen(const QString &name)

指示服务器监听name 上的传入连接。如果服务器已经在监听，则listen()将失败。成功时返回true ，否则返回false 。

name 参数可以是一个名称，QLocalServer 会自动确定正确的平台特定路径。serverName() 将返回传递给 listen() 的名称。

通常您只需传入一个名称（如“foo”），但在 Unix 系统上，这也可以是一个路径（如“/tmp/foo”）；而在 Windows 系统上，这可以是一个管道路径（如“\\.\pipe\foo ”）。

另请参阅 serverName()、isListening() 以及close()。

bool QLocalServer::listen(qintptr socketDescriptor)

指示服务器在socketDescriptor 上监听传入连接。如果服务器当前正在监听，该属性将返回false 。成功时返回true ；否则返回false 。套接字必须已准备好接受新连接，且未调用任何额外的平台特定函数。套接字被设置为非阻塞模式。

serverName如果平台支持此选项，则 `fullServerName()` 可能会返回一个包含名称的字符串；否则，它们将返回空字符串 `QString`。特别需要注意的是，如果 Linux 支持的抽象命名空间中的套接字地址包含不可打印字符，则不会返回有用的名称。

另请参阅 isListening() 和close()。

[since 6.3] int QLocalServer::listenBacklogSize() const

返回待接受连接的积压队列大小。

该函数在 Qt 6.3 中引入。

另请参阅 setListenBacklogSize()。

int QLocalServer::maxPendingConnections() const

返回待处理的已接受连接的最大数量。默认值为 30。

另请参阅 setMaxPendingConnections() 和hasPendingConnections()。

[signal] void QLocalServer::newConnection()

每当有新的连接可用时，都会发出此信号。

另请参阅 hasPendingConnections() 和nextPendingConnection()。

[virtual] QLocalSocket *QLocalServer::nextPendingConnection()

返回下一个待处理的连接，将其作为已连接的QLocalSocket 对象。

该套接字作为服务器的子节点创建，这意味着当QLocalServer 对象被销毁时，它会自动被删除。不过，在不再需要该对象时，仍建议显式地将其删除，以避免浪费内存。

nullptr 若在无待处理连接时调用此函数，则返回 is。

另请参阅 hasPendingConnections()、newConnection() 和incomingConnection()。

[static] bool QLocalServer::removeServer(const QString &name)

移除任何可能导致对listen() 调用失败的服务器实例，若成功则返回true ；否则返回false 。该函数旨在从崩溃中恢复，即当前之前的服务器实例尚未被清理时。

在 Windows 系统上，此函数不执行任何操作；在 Unix 系统上，它会删除由name 指定的套接字文件。

QAbstractSocket::SocketError QLocalServer::serverError() const

返回上次发生的错误类型，或NoError 。

另请参阅 errorString()。

QString QLocalServer::serverName() const

如果服务器正在监听连接，则返回服务器名称；否则返回 QString()。

另请参阅 listen() 和fullServerName()。

[since 6.3] void QLocalServer::setListenBacklogSize(int size)

将待接纳连接的积压队列大小设置为size 。操作系统可能会缩减或忽略此值。默认情况下，队列大小为50。

该函数在 Qt 6.3 中引入。

另请参阅 listenBacklogSize()。

void QLocalServer::setMaxPendingConnections(int numConnections)

将待处理已接受连接的最大数量设置为numConnections 。QLocalServer 在调用nextPendingConnection()之前，最多接受numConnections 个传入连接。

注意：尽管QLocalServer 在达到待处理连接的最大数量后将停止接受新连接，但操作系统仍可能会将这些连接保留在队列中，这将导致客户端报告已建立连接。

另请参阅 maxPendingConnections() 和hasPendingConnections()。

qintptr QLocalServer::socketDescriptor() const

返回服务器用于监听传入指令的原生套接字描述符；如果服务器未处于监听状态，则返回 -1。

描述符的类型取决于平台：

• 在 Windows 系统上，返回值是一个Winsock 2 套接字句柄。
• 在 INTEGRITY 系统上，返回值为QTcpServer 套接字描述符，其类型由socketDescriptor 定义。
• 在所有其他类 UNIX 操作系统上，其类型为表示监听套接字的文件描述符。

另请参阅 listen()。

QLocalServer::SocketOptions QLocalServer::socketOptions() const

返回设置在该套接字上的套接字选项。

另请参阅 setSocketOptions()。

bool QLocalServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)

等待最多msec 毫秒，或直到有可用传入连接为止。如果连接可用，则返回true ；否则返回false 。如果操作超时且timedOut 不为nullptr ，则*timedOut将被设置为true。

这是一个阻塞式函数调用。不建议在单线程 GUI 应用程序中使用它，因为整个应用程序将停止响应，直到该函数返回为止。waitForNewConnection() 主要在没有可用事件循环时才有用。

非阻塞的替代方案是订阅newConnection()信号。

如果 msec 为 -1，则此函数不会超时。

另请参阅 hasPendingConnections() 和nextPendingConnection()。