QNetworkDatagram Class

成员函数文档

创建一个新的QNetworkDatagram ，代表对该传入数据报的回复，并将有效载荷数据设置为payload 。该函数是将数据报回复给原始发送者的一种非常方便的方法。

举例说明

    void Server::readPendingDatagrams()
    {
        while (udpSocket->hasPendingDatagrams()) {
            QNetworkDatagram datagram = udpSocket->receiveDatagram();
            QByteArray replyData = processThePayload(datagram.data());
            udpSocket->writeDatagram(datagram.makeReply(replyData));
        }
    }

此函数特别方便，因为它会自动将此数据报中的参数复制到新数据报中：

• 将此数据报的发送方地址和端口复制到新数据报的目的地址和端口；
• 将该数据报的接口索引（如果有）复制到新数据报的接口索引中；
• 只有当地址是 IPv6 全局（非多播）地址时，该数据报的目标地址和端口才会被复制到新数据报的发送者地址和端口；
• 新数据报的跳数限制重置为默认值（-1）；

如果QNetworkDatagram 在未来的 Qt XML 版本中被修改以携带更多的元数据，此函数将视情况复制这些元数据。

如果该数据报的目标地址是 IPv4 地址，则不会被复制，因为如果不彻底搜索分配给本机的所有地址，就无法将 IPv4 广播地址与普通 IPv4 地址区分开来。如果发送者地址等于广播地址，发送数据报很可能会失败。不过，这应该不会影响通信，因为具有多个 IPv4 地址的网络接口并不常见，所以操作系统选择的地址很可能是对等程序可以理解的地址。

    udpSocket->writeDatagram(std::move(datagram).makeReply(replyData));

QNetworkDatagram::QNetworkDatagram()

创建一个无有效载荷数据和未定义目标地址的 QNetworkDatagram 对象。

有效载荷可通过setData() 修改，目标地址可通过setDestination() 设置。

如果目的地址未定义，QUdpSocket::writeDatagram() 将尝试使用QUdpSocket::connectToHost() 将数据报发送到上次关联的地址。

QNetworkDatagram::QNetworkDatagram(const QByteArray &data, const QHostAddress &destinationAddress = QHostAddress(), quint16 port = 0)

创建 QNetworkDatagram 对象，并将data 设置为有效载荷数据，同时将destinationAddress 和port 设置为数据报的目标地址。

QNetworkDatagram::QNetworkDatagram(const QNetworkDatagram &other)

创建other 数据报的副本，包括有效载荷和元数据。

要创建适合在回复中发送的数据报，请使用QNetworkDatagram::makeReply() ；

void QNetworkDatagram::clear()

清除QNetworkDatagram 对象中的有效载荷数据和元数据，将其重置为默认值。

QByteArray QNetworkDatagram::data() const

返回该数据报的数据有效载荷。对于从网络接收的数据报，它包含数据报的有效载荷。对于发出的数据报，它就是要发送的数据报。

请注意，数据报可以不带数据发送，因此返回的QByteArray 可能是空的。

另请参阅 setData()。

QHostAddress QNetworkDatagram::destinationAddress() const

返回与此数据报相关的目标地址。对于从网络接收的数据报，它是对等节点发送数据报的地址，可以是本机地址，也可以是组播或广播地址。对于发出的数据报，它是数据报应发送到的地址。

如果未在该数据报上设置目标地址，返回的对象将向QHostAddress::isNull() 报告 true。

另请参阅 senderAddress()、destinationPort() 和setDestination()。

int QNetworkDatagram::destinationPort() const

返回与此数据报相关联的目的地端口号。对于从网络接收的数据报，它是对等节点发送数据报的本地端口号。对于发出的数据报，它是数据报应发送到的对等节点端口。

如果该数据报没有关联目标地址，则该函数返回-1。

另请参阅 destinationAddress()、senderPort() 和setDestination()。

int QNetworkDatagram::hopLimit() const

返回与此数据报相关的跳数限制。跳数限制是指在 IP 数据包过期并将错误发回数据报发送方之前，允许转发 IP 数据包的节点数。在 IPv4 中，该值通常称为 "生存时间"（TTL）。

如果该数据报是从网络中接收到的，那么该值就是数据报接收后的剩余跳数，每个转发数据包的节点都会将该值减 1。值为-1 表示无法获得跳数限制。

如果这是一个传出数据报，该值将在发送时设置在 IP 报头中。值为-1 表示操作系统应选择该值。

另请参阅 setHopLimit()。

uint QNetworkDatagram::interfaceIndex() const

返回与该数据报相关联的接口索引。接口索引是一个正数，在操作系统中唯一标识网络接口。该数字与QNetworkInterface::index() 返回的接口值一致。

如果该数据报是从网络接收的，那么这就是接收数据包的接口索引。如果是发出的数据报，这是数据报应在哪个接口上发送的索引。

值为 0 表示接口索引未知。

另请参阅 setInterfaceIndex()。

bool QNetworkDatagram::isNull() const

如果QNetworkDatagram 对象为空，则返回 true。该函数与isValid() 相反。

bool QNetworkDatagram::isValid() const

如果QNetworkDatagram 对象有效，则返回 true。有效的QNetworkDatagram 对象至少包含一个发送方或接收方地址。有效数据报可以包含空有效载荷。

QHostAddress QNetworkDatagram::senderAddress() const

返回与该数据报相关的发送方地址。对于从网络接收的数据报，它是发送该数据报的对等节点的地址。对于发出的数据报，它是发送时使用的本地地址。

如果未在该数据报上设置发件人地址，返回的对象将向QHostAddress::isNull() 报告为 "true"。

另请参阅 destinationAddress()、senderPort() 和setSender()。

int QNetworkDatagram::senderPort() const

返回与该数据报相关的发送方的端口号。对于从网络接收的数据报，它是对等节点发送数据报的端口号。对于发出的数据报，它是数据报应从的本地端口。

如果该数据报没有关联发件人地址，则该函数返回-1。

另请参阅 senderAddress()、destinationPort() 和setSender()。

void QNetworkDatagram::setData(const QByteArray &data)

将此数据报的数据有效载荷设置为data 。通常情况下，无需在接收到的数据报上调用此函数。对于发出的数据报，该函数将设置要在网络上发送的数据。

data由于数据报可以为空，因此QByteArray 的有效值为空。

另请参阅 data()。

void QNetworkDatagram::setDestination(const QHostAddress &address, quint16 port)

将与该数据报相关联的目标地址设置为地址address 和端口号port 。目标地址和端口号通常由QUdpSocket 在接收时设置，因此无需在接收数据报时调用此函数。

对于发出的数据报，该函数可用于设置数据报应发送到的地址。它可以是用于与对等设备通信的单播地址，也可以是发送给一组设备的广播或组播地址。

另请参阅 QUdpSocket::writeDatagram()、destinationAddress()、destinationPort() 和setSender()。

void QNetworkDatagram::setHopLimit(int count)

将与此数据报相关的跳数限制设置为count 。跳数限制是指在 IP 数据包过期并向数据报发送者发送错误信息之前，允许转发 IP 数据包的节点数。在 IPv4 中，该值通常称为 "生存时间"（TTL）。

从网络接收的数据报通常无需调用此函数。

如果这是一个发出的数据包，则该值将在发送时设置在 IP 报头中。该值的有效范围是 1 至 255。该函数还接受-1 的值，表示操作系统应选择该值。

另请参阅 hopLimit()。

void QNetworkDatagram::setInterfaceIndex(uint index)

将与该数据报关联的接口索引设置为index 。接口索引是一个正数，在操作系统中唯一标识网络接口。该数字与QNetworkInterface::index() 返回的接口值相匹配。

从网络接收数据报时，通常无需调用此函数。

如果这是一个发出的数据包，这就是数据报应在哪个接口上发送的索引。值为 0 表示操作系统应根据其他因素选择接口。

请注意，对于 IPv6 目标地址，也可以使用QHostAddress::setScopeId() 设置接口索引，然后再使用setDestination() 设置。如果目的地址和index 中设置的作用域 ID 不同，且都不为 0，则无法确定操作系统将在哪个接口上发送数据报。

另请参阅 interfaceIndex() 和 setInterfaceIndex()。

void QNetworkDatagram::setSender(const QHostAddress &address, quint16 port = 0)

将与该数据报相关联的发件人地址设置为address 和端口号port 。发件人地址和端口号通常由QUdpSocket 在接收时设置，因此无需在接收到的数据报上调用此函数。

对于发出的数据报，该函数可用于设置数据报应携带的地址。address 通常必须是分配给本机的本地地址之一，可通过QNetworkInterface 获取。如果不设置，操作系统将根据目的地选择最合适的地址。

端口号port 必须是与套接字相关联的端口号（如果有的话）。可以使用 0 表示操作系统应选择端口号。

另请参阅 QUdpSocket::writeDatagram()、senderAddress()、senderPort() 和setDestination()。

[noexcept] void QNetworkDatagram::swap(QNetworkDatagram &other)

将该数据报与other 互换。该操作速度非常快，从未出现过故障。

QNetworkDatagram &QNetworkDatagram::operator=(const QNetworkDatagram &other)

复制other 数据报，包括有效载荷和元数据。

要创建适合在回复中发送的数据报，请使用QNetworkDatagram::makeReply() ；