Qt之QLocalSocket

本文介绍了QLocalSocket类的功能,包括其在Windows和Unix系统中的作用原理,错误处理方式及主要成员函数的使用方法。详细解释了如何建立和管理本地socket连接。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

简述

QLocalSocket类提供了一个本地socket。

在Windows中,这是一个命名管道;在Unix中,这是一个本地网域socket。

如果发生错误,socketError()会返回错误的类型,errorString()则返回人类可读的错误描述。

虽然QLocalSocket是一个事件循环使用而设计,它也可以不被如此使用。这种情况下,必须使用
waitForConnected()、waitForReadyRead()、waitForBytesWritten()、和waitForDisconnected()来进行阻塞,直到操作完成或超时。

成员类型文档

枚举 QLocalSocket::LocalSocketError

LocalServerError枚举代表了可能发生的错误,最近的错误可以通过调用QLocalSocket::error()来获取。

常量描述
QLocalSocket::ConnectionRefusedErrorQAbstractSocket::ConnectionRefusedError连接被对方拒绝(或超时)
QLocalSocket::PeerClosedErrorQAbstractSocket::RemoteHostClosedError远程socket关闭了连接。请注意,在远程关闭通知发送后,client socket(即,这个socket)将关闭。
QLocalSocket::ServerNotFoundErrorQAbstractSocket::HostNotFoundError本地socket名字没有被发现
QLocalSocket::SocketAccessErrorQAbstractSocket::SocketAccessErrorsocket操作失败,因为应用程序缺乏必要的特权。
QLocalSocket::SocketResourceErrorQAbstractSocket::SocketResourceError本地系统超出资源(例如:太多的socket)
QLocalSocket::SocketTimeoutErrorQAbstractSocket::SocketTimeoutErrorsocket操作超时。
QLocalSocket::DatagramTooLargeErrorQAbstractSocket::DatagramTooLargeError数据报比操作系统的限制(可低至8192字节)大。
QLocalSocket::ConnectionErrorQAbstractSocket::NetworkError连接时发生错误
QLocalSocket::UnsupportedSocketOperationErrorQAbstractSocket::UnsupportedSocketOperationError本地操作系统不支持请求的socket操作
QLocalSocket::OperationErrorQAbstractSocket::OperationError当socket在一个不允许它的状态中时,试图进行操作。
QLocalSocket::UnknownSocketErrorQAbstractSocket::UnknownSocketError发生无法识别的错误


枚举 QLocalSocket::LocalSocketState

这个枚举描述一个套接字的不同状态。

常量描述
QLocalSocket::UnconnectedStateQAbstractSocket::UnconnectedStatesocket未连接
QLocalSocket::ConnectingStateQAbstractSocket::ConnectingStatesocket已开始建立连接
QLocalSocket::ConnectedStateQAbstractSocket::ConnectedState建立连接
QLocalSocket::ClosingStateQAbstractSocket::ClosingStatesocket即将关闭(数据仍可以等待写入)

Public函数

void abort()

终止当前连接,并重置socket。与disconnectFromServer()不同,此函数会立即关闭socket,并且清除掉写缓冲区中未处理的数据。

void connectToServer(OpenMode openMode = ReadWrite)

尝试创建一个到serverName()的连接。在打开连接之前必须调用setServerName();或者可以使用connectToServer(const QString &name, OpenMode openMode)。

以指定的openMode打开socket,首先进入ConnectingState,如果建立了连接,QLocalSocket进入ConnectedState,并发射connected()信号。

调用此函数后,当发生错误时,socket会发射error()信号。

void connectToServer(const QString &name, OpenMode openMode = ReadWrite)

重载函数

void disconnectFromServer()

尝试关闭socket。如果缓冲区中仍有等待写入的数据,QLocalSocket将进入ClosingState状态,然后等待,直到所有数据写完。最终,QLocalSocket进入UnconnectedState状态,发射disconnectedFromServer()信号。

LocalSocketError error() const

返回最后发生的错误类型。

bool flush()

此函数能够无阻塞地将内部写缓冲区中的数据尽可能多的写入到socket中。当有任何数据被写入时,返回true;否则返回false。
当需要QLocalSocket立即发送缓冲区中的数据时,可以调用此函数。成功写入的字节数取决于操作系统。在大多数情况下,不需要调用该函数,因为一旦事件循环得到了控制权之后,QLocalSocket就会自动的开始发送数据。当没有事件循环时,调用waitForBytesWritten()代替。

QString fullServerName() const

返回socket连接到的server path。

注意:返回值因操作系统不同存在差异。

bool isValid() const

如果socket是有效的并且并且可以使用了,返回ture;否则返回false。

注意: socket进行读/写之前,一定是处于ConnectedState状态。

qint64 readBufferSize() const

返回内部读取缓冲区的大小。在调用read()或readAll()之前,这限制了client接收的数据量。读缓冲区大小为0(默认)意味着缓冲区没有大小限制,确保没有数据丢失。

QString serverName() const

返回由setServerName()指定的server的name。如果没有调用setServerName(),或者connectToServer()失败,返回空字符串。

void setReadBufferSize(qint64 size)

设置QLocalSocket内部读缓冲区的大小为size个字节。

如果缓冲区被限制为一定的大小,QLocalSocket不会缓冲超过这个数据的大小。

如果设置了指定的size,QLocalSocket最多只能缓存该size大小的数据。特殊地,大小为0的缓冲区意味着读缓冲区是无限的,并且所有传入数据都会得到缓冲,这是默认的。

如果你只在特定的时间点(例如:在一个实时流媒体应用程序)读数据,或者想保护你的socket避免接收太多的数据(这最终可能会导致应用程序耗尽内存),这个选项是有用的。

void setServerName(const QString &name)

设置对等连接的名称。在Windows中,名字是命名管道的名称;在Unix中,名称是本地域socket的名称。
当未连接socket时,此函数必须被调用。

bool setSocketDescriptor(qintptr socketDescriptor, LocalSocketState socketState = ConnectedState, OpenMode openMode = ReadWrite)

使用本地socket描述符socketDescriptor完成QLocalSocket的初始化。如果socketDescriptor被接受为一个有效的socket描述符,返回true;否则返回false。socket被以指定的模式openMode打开,并进入socketState指定的socket状态。

注意:无法使用相同的本地socket描述符来初始化两个本地socket。

qintptr socketDescriptor() const

如果可用,返回QLocalSocket对象的本地socket描述符。否则,返回-1。

当QLocalSocket处于UnconnectedState状态时,socket描述符无效。

LocalSocketState state() const

返回socket的状态。

bool waitForConnected(int msecs = 30000)

等待,直到socket连接。直到msecs毫秒。如果连接已建立,返回true;否则返回false。返回false时,可以调用error()来确定错误的原因。

下面的例子最多等待1秒来建立连接:

socket->connectToServer("market");
if (socket->waitForConnected(1000))
    qDebug("Connected!");

如果msecs是-1,该函数不会超时。

bool waitForDisconnected(int msecs = 30000)

等待,直到socket断开。直到msecs毫秒。如果连接已断开,返回true;否则返回false。返回false时,可以调用error()来确定错误的原因。

下面的例子最多等待1秒来断开连接:

socket->disconnectFromServer();
if (socket->waitForDisconnected(1000))
    qDebug("Disconnected!");

如果msecs是-1,该函数不会超时。

信号

void connected()

调用connectToServer()之后,并且成功建立连接,发射此信号。

void disconnected()

当socket已经断开连接,发射此信号。

void error(QLocalSocket::LocalSocketError socketError)

当有错误发生时,会发射此信号。参数socketError表明发生错误的类型。

QLocalSocket::LocalSocketError不是一个注册的metatype,所以在queued connections时,需要使用Q_DECLARE_METATYPE()和qRegisterMetaType()注册它。

**注意:**error是这个类的一个重载信号。要连接这个信号,需要使用函数指针语法,必须在static_cast中指定信号类型,如本例所示:

connect(localSocket, static_cast<void(QLocalSocket::*)(QLocalSocket::LocalSocketError)>(&QLocalSocket::error), [=](QLocalSocket::LocalSocketError socketError){ /* ... */ });

void stateChanged(QLocalSocket::LocalSocketState socketState)

当QLocalSocket的状态改变时,发射此信号。参数socketState是新状态。

QLocalSocket::SocketState不是一个注册的metatype,所以在queued connections时,需要使用Q_DECLARE_METATYPE()和qRegisterMetaType()注册它。

重新实现的Public函数

[virtual] qint64 bytesAvailable() const

重新实现QIODevice::bytesAvailable()。

[virtual] qint64 bytesToWrite() const

重新实现QIODevice::bytesToWrite()。

[virtual] bool canReadLine() const

重新实现QIODevice::canReadLine()。

[virtual] void close()

重新实现QIODevice::close()。

[virtual] bool isSequential() const

重新实现QIODevice::isSequential()。

[virtual] bool waitForBytesWritten(int msecs = 30000)

重新实现QIODevice::waitForBytesWritten()。

[virtual] bool waitForReadyRead(int msecs = 30000)

重新实现QIODevice::waitForReadyRead()。

此函数阻塞,直到数据可供阅读并且readyRead()信号被发射。在msecs毫秒后,就会超时;默认的超时时间为30000毫秒。

如果数据可供阅读,该函数返回true;否则返回false(如果发生错误或操作超时)。

[virtual] bool open(OpenMode openMode = ReadWrite)

重新实现QIODevice::open()。

相当于connectToServer(OpenMode mode),以指定的openMode打开socket至setServerName()定义的server。

注意:不像其他大多数的QIODevice子类,open()可以不直接打开设备。如果socket已连接或server连接到没有定义,该函数返回false,其他情况返回true。一旦设备打开(或连接失败),就会发射信号connected()或error()。

重新实现的Protected函数

qint64 readData(char *data, qint64 c)

重新实现QIODevice::readData()。

qint64 writeData(const char *data, qint64 c)

重新实现QIODevice::writeData()。

### 回答1: Qt中的QLocalSocket是一种用于进程间通信的组件。它允许不同的进程在同一台计算机上进行通信,通过该组件可以实现进程之间的数据交换和信息传递。 QLocalSocketQt的网络类之一,它继承自QTcpSocket类,用于在本地主机上建立起客户端-服务器类型的连接。使用QLocalSocket进行进程间通信的基本步骤如下: 首先,创建一个QLocalSocket对象,并调用connectToServer()函数连接到目标进程的服务器端。在目标进程中,需要创建一个QLocalServer对象并调用其listen()函数来创建服务器端。 然后,通过write()函数向服务器端发送需要传递的数据。服务器端可以通过继承QLocalServer并重载incomingConnection()函数来接收客户端的连接请求,并使用read()函数读取来自客户端的数据。 QLocalSocket还提供了readyRead()信号,用于在客户端接收到数据时触发相应的槽函数进行处理。同时,error()信号可以用来捕获任何连接错误。 当数据传递完成后,可以调用disconnectFromServer()函数来断开客户端与服务器端之间的连接。 总之,QtQLocalSocket组件提供了一种方便和简单的方式实现进程间通信。通过使用QLocalSocket,不同进程之间可以直接交换数据和信息,实现一些特定的功能,提高了应用程序的灵活性和可扩展性。 ### 回答2: Qt中的QLocalSocket类可用于进程间通信。进程间通信是指两个或多个不同的进程之间交换数据或消息的过程。在Qt中,可以使用QLocalSocket类在本地主机上的进程间建立通信。 QLocalSocket是一个套接字(Socket)类,它可以在本地主机上的不同进程之间建立双向通信。要使用QLocalSocket进行进程间通信,首先需要创建一个QLocalServer对象作为服务器端,等待其他进程连接。然后在客户端进程中,创建一个QLocalSocket对象,用于与服务器端建立连接。 服务器端代码示例: ```cpp QLocalServer server; if (!server.listen("myApp")) { // 服务器启动失败 return; } // 服务器等待连接 QLocalSocket *socket = server.nextPendingConnection(); if (!socket) { // 连接失败 return; } // 接收数据 QObject::connect(socket, &QLocalSocket::readyRead, [&socket]() { QByteArray data = socket->readAll(); // 处理接收到的数据 }); // 发送数据给客户端 QByteArray sendData = "Hello from server"; socket->write(sendData); ``` 客户端代码示例: ```cpp QLocalSocket socket; socket.connectToServer("myApp"); // 检查连接状态 if (socket.state() != QLocalSocket::ConnectedState) { // 连接失败 return; } // 发送数据给服务器端 QByteArray sendData = "Hello from client"; socket.write(sendData); // 接收服务器端发来的数据 QObject::connect(&socket, &QLocalSocket::readyRead, [&socket]() { QByteArray data = socket.readAll(); // 处理接收到的数据 }); ``` 以上示例代码演示了一个基本的QLocalSocket进程间通信的过程。服务器端创建QLocalServer对象并等待连接,客户端连接到服务器端并发送数据。服务器端收到数据后进行处理,然后发送数据给客户端。客户端接收到服务器端发送的数据后进行处理。 总而言之,使用QLocalSocket类可以实现方便的进程间通信,方便不同进程之间的数据交换和消息传递。 ### 回答3: qtQLocalSocket类是一个用于进程间通信的工具。进程间通信是指不同进程之间进行交流和数据传输的过程。 QLocalSocket通过本地套接字(Local Socket)来实现进程间通信。本地套接字是一种特殊的套接字类型,它允许在同一台机器上的不同进程之间进行通信,而不需要经过网络。 使用QLocalSocket进行进程间通信的基本步骤如下: 1. 创建一个QLocalServer对象,用于监听连接请求。本地服务器类(QLocalServer)提供了一种在本地环境中创建服务器的方法。 2. 创建一个QLocalSocket对象,用于与服务端建立连接。本地套接字类(QLocalSocket)提供了一种在本地环境中创建套接字的方法。 3. 在服务端,接受连接请求并建立连接。当服务端收到一个连接请求时,可以使用QLocalServer的nextPendingConnection()方法接受请求并返回一个QLocalSocket对象,用于进一步的通信。 4. 在客户端,连接到服务端。客户端使用QLocalSocket的connectToServer()方法来连接到服务端。 5. 通过QLocalSocket对象进行数据传输。一旦连接建立,就可以使用QLocalSocket的write()方法向对方发送数据,使用read()方法读取对方发送的数据。 QLocalSocket具有很多特性,例如支持阻塞和非阻塞的通信方式、支持对错误进行处理、支持多线程等。通过使用QLocalSocket,我们可以方便地在同一台机器上的不同进程之间进行通信,实现进程间的数据传输和交流。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值