Пространство имён QtCoap

Содержит различные идентификаторы, используемые в модуле Qt CoAP. Подробнее...

Заголовок:	#include <QtCoap>
qmake:	QT += coap

Типы

Перечисление	Ошибка { Ok, HostNotFound, AddressInUse, TimeOut, BadRequest, …, Unknown }
Перечисление	Метод { Invalid, Get, Post, Put, Delete, Other }
Перечисление	Группа многоадресной рассылки { AllCoapNodesIPv4, AllCoapNodesIPv6LinkLocal, AllCoapNodesIPv6SiteLocal }
Перечисление	Порт { DefaultPort, DefaultSecurePort }
Перечисление	Код ответа { EmptyMessage, Created, Deleted, Valid, Changed, …, InvalidCode }
Перечисление	Режим безопасности { NoSecurity, PreSharedKey, RawPublicKey, Certificate }

Подробное описание

Документация по типам

Перечисление QtCoap::Ошибка

Указывает состояние ошибки, обнаруженной при обработке запроса.

Константа	Значение	Описание
`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`	Произошла неизвестная ошибка.

Перечисление QtCoap::Метод

Это перечисление определяет методы запросов 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`	Другой метод запроса.

Перечисление QtCoap::Группа многоадресной рассылки

Это перечисление представляет адреса групп многоадресной рассылки CoAP, определённые в RFC 7252.

Константа	Значение	Описание
`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 многоадресной рассылки".

Перечисление QtCoap::Порт

Это перечисление определяет значения портов CoAP по умолчанию.

Константа	Значение	Описание
`QtCoap::DefaultPort`	`5683`	Порт по умолчанию, используемый для ненадежной передачи.
`QtCoap::DefaultSecurePort`	`5684`	Порт по умолчанию, используемый для защищённой передачи.

Перечисление QtCoap::Код ответа

Это перечисление представляет код ответа от протокола 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 "Метод запрещён", но без аналогичного поля заголовка "Allow".
`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 или схемы в Proxy-Scheme.
`QtCoap::ResponseCode::InvalidCode`	`0xFF`	Недопустимый код ответа.

Перечисление QtCoap::SecurityMode

Указывает режим безопасности, используемый для защиты соединения CoAP, как определено в RFC 7252.

Постоянная	Значение	Описание
`QtCoap::SecurityMode::NoSecurity`	`0`	Отсутствует безопасность на уровне протокола (DTLS отключён).
`QtCoap::SecurityMode::PreSharedKey`	`1`	DTLS включён. Для безопасности будет использоваться аутентификация PSK.
`QtCoap::SecurityMode::RawPublicKey`	`2`	DTLS включён. Для безопасности будет использована асимметричная пара ключей без сертификата (сырой открытый ключ). Этот режим ещё не поддерживается.
`QtCoap::SecurityMode::Certificate`	`3`	DTLS включён. Для безопасности будет использована асимметричная пара ключей с сертификатом X.509.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qtcoap.html