QLocalServer 类

成员函数文档

QLocalServer::[显式]QLocalServer(QObject *] = nullptr)

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

另请参阅listen()。

QLocalServer::[虚拟 noexcept]~QLocalServer()

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

任何仍然连接的 QLocalSockets 客户端必须在服务器删除之前断开连接或被重新父化。

另请参阅close()。

void QLocalServer::close()

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

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

QString QLocalServer::errorString() const

返回适合由 serverError 报告的当前错误的文本消息。如果没有可用的合适字符串，则返回空字符串。

另请参阅serverError()。

QString QLocalServer::fullServerName() const

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

注意：这是平台特定的

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

[虚拟] bool QLocalServer::hasPendingConnections() const

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

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

[虚拟保护] 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 上的传入连接。如果服务器目前正在监听，则将返回 false。成功时返回 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()。

[自 6.3 开始] int QLocalServer::listenBacklogSize() const

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

此函数在 Qt 6.3 中引入。

另请参阅setListenBacklogSize。

int QLocalServer::maxPendingConnections() const

返回最大挂起的已接受连接数。默认为 30。

另请参阅setMaxPendingConnections 和 hasPendingConnections。

[信号] void QLocalServer::newConnection()

每次有新的连接可用时都会发射此信号。

另请参阅hasPendingConnections 和 nextPendingConnection。

[虚拟] QLocalSocket *QLocalServer::nextPendingConnection()

返回下一个挂起的连接，作为一个已连接的 QLocalSocket 对象。

套接字是在服务器的子集中创建的，这意味着当 QLocalServer 对象被销毁时，它会自动被删除。完成使用后仍然建议显式删除对象，以避免内存浪费。

如果没有挂起的连接，则此函数调用会返回 nullptr。

另请参阅hasPendingConnections、newConnection 和 incomingConnection。

[静态] 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。

[自 6.3 开始] void QLocalServer::setListenBacklogSize(int size)

将待接受连接的队列大小设置为 size。操作系统可能会减少或忽略此值。默认队列大小为 50。

此函数在 Qt 6.3 中引入。

另请参阅listenBacklogSize。

void QLocalServer::setMaxPendingConnections(int numConnections)

设置待接受连接的最大数量为 numConnections。在调用 nextPendingConnection() 之前，QLocalServer 将不会接受超过 numConnections 的传入连接。

注意：尽管在达到其最大待处理连接数量后，QLocalServer 将停止接受新的连接，但操作系统可能会将它们保留在队列中，导致客户端发出已连接的信号。

另请参阅maxPendingConnections() 和 hasPendingConnections。

qintptr QLocalServer::socketDescriptor() const

返回服务器用于监听传入指令的本地套接字描述符，如果服务器没有监听则返回 -1。

描述符的类型取决于平台

• 在 Windows 上，返回的值是一个 Winsock 2 Socket Handle。
• 在 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。