实现QIODevice::writeData,混淆文档

Implementing QIODevice::writeData, confusing documentation

本文关键字:文档 writeData QIODevice 实现      更新时间:2023-10-16

我正在尝试为实时音频应用程序实现双缓冲区,QAudioInput要求它是QIODevice的子类。我发现这个方法的文档非常混乱。

首先,文档中的方法签名与具有virtual qint64 writeData(const char *data, qint64 len) = 0;的QT 5.9.2的标头不匹配。

文件上有这样的签名:qint64 QIODevice::writeData(const char *data, qint64 maxSize)

maxSize参数让我很困惑,因为它意味着我只能缓冲一些数据,文档中也暗示了这一点:

将数据中最多maxSize个字节写入设备。返回写入的字节数,如果发生错误,则返回-1

然而,文档紧接着说了这句话,这对我来说似乎很矛盾:

重新实现此函数时,重要的是此函数在返回之前写入所有可用数据。这是QDataStream能够对类进行操作所必需的。QDataStream假定所有信息都已写入,因此在出现问题时不会重试写入。

那么,我的QIODevice实现是否负责在单个调用中缓冲所有数据?

他们基本上想说的是:传递的datamaxSize字节长。您的实现应该写入所有数据并返回写入的字节数。

可以写更少的可用数据,但不应该这样做。如果你这样做了,一些使用你的设备的类可能不会对此做出反应(比如QDataStream)。这取决于QAudioInput如何处理写调用。如果它检查结果,并在未完全写入的情况下再次写入丢失的数据,则不写入所有数据是可以的。如果不是这样的话,你必须总是写所有的数据。

只需尝试一下:总是只写1个字节(并返回1)。如果它有效,那也没关系,否则你必须始终写入所有传递的数据,否则以-1失败。