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 上的传入连接。如果服务器正在监听，则返回 false。成功时返回 true，否则返回 false。

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

通常只需传入一个名称，如 "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 如果在没有待处理连接的情况下调用此函数，则返回 。

另请参阅 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在调用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。

这是一个阻塞函数调用。在单线程图形用户界面应用程序中不宜使用该函数，因为在函数返回之前，整个应用程序将停止响应。waitForNewConnection() 在没有事件循环可用时非常有用。

非阻塞的替代方法是连接到newConnection() 信号。

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

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