QtCoap 空间名

包含在整个 Qt CoAP 模块中使用的各种标识符。更多...

头文件	#include <QtCoap>
CMake	find_package(Qt6 REQUIRED COMPONENTS Coap) target_link_libraries(mytarget PRIVATE Qt6::Coap)
qmake	QT += coap

类型

枚举类	Error { Ok, HostNotFound, AddressInUse, TimeOut, BadRequest, …, Unknown }
枚举类	Method { Invalid, Get, Post, Put, Delete, Other }
枚举类	MulticastGroup { AllCoapNodesIPv4, AllCoapNodesIPv6LinkLocal, AllCoapNodesIPv6SiteLocal }
枚举	Port { DefaultPort, DefaultSecurePort }
枚举类	ResponseCode { EmptyMessage, Created, Deleted, Valid, Changed, …, InvalidCode }
枚举类	SecurityMode { NoSecurity, PreSharedKey, RawPublicKey, Certificate }

详细描述

类型文档

枚举类 QtCoap::Error

指示在处理请求过程中找到的错误条件。

常量	值	描述
`QtCoap::Error::Ok`	`0`	没有错误条件。
`QtCoap::Error::HostNotFound`	`1`	未找到远程主机名称。
`QtCoap::Error::AddressInUse`	`2`	地址已被使用。
`QtCoap::Error::TimeOut`	`3`	响应未及时到达。
`QtCoap::Error::BadRequest`	`4`	请求未被识别。
`QtCoap::Error::Unauthorized`	`5`	客户端未授权执行所请求的操作。
`QtCoap::Error::BadOption`	`6`	由于一个或多个未识别或损坏的选项，请求无法被服务器理解。
`QtCoap::Error::Forbidden`	`7`	禁止访问此资源。
`QtCoap::Error::NotFound`	`8`	请求的资源未找到。
`QtCoap::Error::MethodNotAllowed`	`9`	服务器不允许用于请求的 URL 调用的方法。
`QtCoap::Error::NotAcceptable`	`10`	未找到满足请求接受标准的资源。
`QtCoap::Error::RequestEntityIncomplete`	`11`	服务器尚未收到它需要继续处理的请求体块。客户端尚未发送所有块，或没有按照服务器要求的顺序发送，或发送时间太长，以至于服务器已经丢弃了它们。
`QtCoap::Error::PreconditionFailed`	`12`	请求头字段中给出的一个或多个条件在服务器上测试时评估为假。
`QtCoap::Error::RequestEntityTooLarge`	`13`	请求负载大于服务器愿意或能够处理的。
`QtCoap::Error::UnsupportedContentFormat`	`14`	有效负载的格式不适用于目标资源上的此方法。
`QtCoap::Error::InternalServerFault`	`15`	服务器遇到了无法满足请求的意外条件。
`QtCoap::Error::NotImplemented`	`16`	服务器不支持满足请求所需的功能。
`QtCoap::Error::BadGateway`	`17`	上游服务器出现错误。
`QtCoap::Error::ServiceUnavailable`	`18`	服务目前不可用。
`QtCoap::Error::GatewayTimeout`	`19`	作为网关或代理的服务器，在完成请求时未收到所需访问的上游服务器的及时响应。
`QtCoap::Error::ProxyingNotSupported`	`20`	服务器无法或不愿意作为指定在Proxy-Uri选项中的URI或使用Proxy-Scheme指定的方案的转发代理。
`QtCoap::Error::Unknown`	`21`	发生了未知错误。

enum class QtCoap::Method

此枚举指定了CoAP请求方法。

常量	值	描述
`QtCoap::Method::Invalid`	`0`	空请求的默认请求方法。
`QtCoap::Method::Get`	`1`	GET方法。
`QtCoap::Method::Post`	`2`	POST方法。
`QtCoap::Method::Put`	`3`	PUT方法。
`QtCoap::Method::Delete`	`4`	DELETE方法。
`QtCoap::Method::Other`	`5`	其他请求方法。

enum class QtCoap::MulticastGroup

此枚举表示在RFC 7252中定义的CoAP多播组地址。

常量	值	描述
`QtCoap::MulticastGroup::AllCoapNodesIPv4`	`0`	IPv4 "所有CoAP节点"地址 224.0.1.187，来自"IPv4多播地址空间注册表"。
`QtCoap::MulticastGroup::AllCoapNodesIPv6LinkLocal`	`1`	IPv6 "所有CoAP节点"链路本地作用域地址 FF02::FD，来自"IPv6多播地址空间注册表"。
`QtCoap::MulticastGroup::AllCoapNodesIPv6SiteLocal`	`2`	IPv6 "所有CoAP节点"站点本地作用域地址 FF05::FD，来自"IPv6多播地址空间注册表"。

enum QtCoap::Port

此枚举指定了默认的CoAP端口号值。

常量	值	描述
`QtCoap::DefaultPort`	`5683`	用于非安全传输的默认端口号。
`QtCoap::DefaultSecurePort`	`5684`	用于安全传输的默认端口号。

enum class QtCoap::ResponseCode

此枚举表示CoAP协议的响应代码，如RFC 7252和RFC 7959中定义。

常量	值	描述
`QtCoap::ResponseCode::EmptyMessage`	`0x00`	空消息的响应代码。
`QtCoap::ResponseCode::Created`	`0x41`	请求成功，并导致创建了新的资源。此响应代码对应HTTP 201 "已创建"。
`QtCoap::ResponseCode::Deleted`	`0x42`	资源已成功删除。此响应代码对应HTTP 204 "无内容"，但仅用于响应导致资源不再可用的请求，例如DELETE和在某些情况下POST。
`QtCoap::ResponseCode::Valid`	`0x43`	此响应代码与HTTP 304 "未修改"相关，但仅用于指示由ETag选项中给出的实体标签标识的响应是有效的。
`QtCoap::ResponseCode::Changed`	`0x44`	资源已成功修改。此响应代码对应HTTP 204 "无内容"，但仅用于响应POST和PUT请求。
`QtCoap::ResponseCode::Content`	`0x45`	请求成功。此响应代码对应HTTP 200 "OK"，但仅用于响应GET请求。
`QtCoap::ResponseCode::Continue`	`0x5F`	指示当前块的传输成功，服务器将发送更多块。
`QtCoap::ResponseCode::BadRequest`	`0x-80`	未识别请求。此响应代码对应HTTP 400 "错误请求"。
`QtCoap::ResponseCode::Unauthorized`	`0x-7f`	客户端无权执行请求的操作。此响应代码对应HTTP 401 "未授权"。
`QtCoap::ResponseCode::BadOption`	`0x-7e`	服务器由于无法识别的选项而无法理解此请求。
`QtCoap::ResponseCode::Forbidden`	`0x-7d`	禁止访问此资源。此响应代码对应于HTTP 403 "禁止"。
`QtCoap::ResponseCode::NotFound`	`0x-7c`	未找到请求的资源。此响应代码对应于HTTP 404 "未找到"。
`QtCoap::ResponseCode::MethodNotAllowed`	`0x-7b`	服务器不允许用于请求URL的方法。此响应代码对应于HTTP 405 "方法不被允许"，但没有与"允许"标题字段相对应的关系。
`QtCoap::ResponseCode::NotAcceptable`	`0x-7a`	没有找到满足请求接受标准的资源。此响应代码对应于HTTP 406 "不可接受"，但没有响应实体。
`QtCoap::ResponseCode::RequestEntityIncomplete`	`0x-78`	服务器尚未接收到执行请求所需的整个请求体。
`QtCoap::ResponseCode::PreconditionFailed`	`0x-74`	请求标题字段中给出的条件在服务器上测试时评估为`false`。此响应代码对应于HTTP 412 "条件失败"。
`QtCoap::ResponseCode::RequestEntityTooLarge`	`0x-73`	请求有效负载大于服务器愿意或能够处理的。此响应代码对应于HTTP 413 "请求实体过大"。
`QtCoap::ResponseCode::UnsupportedContentFormat`	`0x-72`	有效负载处于目标资源不支持此方法的格式。此响应代码对应于HTTP 415 "不支持的媒体类型"。
`QtCoap::ResponseCode::InternalServerFault`	`0x-60`	服务器遇到意外条件，阻止它满足请求。此响应代码对应于HTTP 500 "内部服务器错误"。
`QtCoap::ResponseCode::NotImplemented`	`0x-5f`	服务器不支持满足请求所需的功能。此响应代码对应于HTTP 501 "未实现"。
`QtCoap::ResponseCode::BadGateway`	`0x-5e`	上游服务器发生错误。此响应代码对应于HTTP 502 "不良网关"。
`QtCoap::ResponseCode::ServiceUnavailable`	`0x-5d`	服务目前不可用。此响应代码对应于HTTP 503 "服务不可用"。
`QtCoap::ResponseCode::GatewayTimeout`	`0x-5c`	作为网关或代理服务器运行时，服务器没有及时从上游服务器收到响应。此响应代码对应于HTTP 504 "网关超时"。
`QtCoap::ResponseCode::ProxyingNotSupported`	`0x-5b`	服务器无法或不愿意作为指定在Proxy-Uri选项中的URI或使用Proxy-Scheme指定的方案的转发代理。
`QtCoap::ResponseCode::InvalidCode`	`0xFF`	无效的响应代码。

enum class QtCoap::SecurityMode

指定用于保护CoAP连接的安全性模式，如RFC 7252中定义。

常量	值	描述
`QtCoap::SecurityMode::NoSecurity`	`0`	没有协议级安全（DTLS已禁用）。
`QtCoap::SecurityMode::PreSharedKey`	`1`	DTLS已启用。将使用预共享密钥进行安全。
`QtCoap::SecurityMode::RawPublicKey`	`2`	DTLS已启用。将使用不对称密钥对（不带证书的原始公钥）进行安全。此模式目前不受支持。
`QtCoap::SecurityMode::Certificate`	`3`	DTLS已启用。将使用带有X.509证书的不对称密钥对进行安全。