Пространство имён QtCoap
Содержит различные идентификаторы, используемые в модуле Qt CoAP. Подробнее...
| Заголовок: | #include <QtCoap> |
| qmake: | QT += coap |
Типы
| Перечисление | Ошибка { Ok, HostNotFound, AddressInUse, TimeOut, BadRequest, …, Unknown } |
| Перечисление | Метод { Invalid, Get, Post, Put, Delete, Other } |
| Перечисление | ГруппаMulticast { 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::Метод
Этот перечисление определяет методы запросов 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
Это перечисление представляет адреса групп CoAP multicast, определённые в RFC 7252.
| Постоянная | Значение | Описание |
|---|---|---|
QtCoap::MulticastGroup::AllCoapNodesIPv4 |
0 |
Адрес IPv4 "Все узлы CoAP" 224.0.1.187 из "Реестра адресов IPv4 multicast". |
QtCoap::MulticastGroup::AllCoapNodesIPv6LinkLocal |
1 |
Адрес IPv6 "Все узлы CoAP" link-local с областью действия FF02::FD из "Реестра адресов IPv6 multicast". |
QtCoap::MulticastGroup::AllCoapNodesIPv6SiteLocal |
2 |
Адрес IPv6 "Все узлы CoAP" site-local с областью действия FF05::FD из "Реестра адресов IPv6 multicast". |
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 |
Сервер не может или не хочет действовать как прокси-сервер для URI, указанного в опции Proxy-Uri, или используя схему, указанную в Proxy-Scheme. |
QtCoap::ResponseCode::InvalidCode |
0xFF |
Неверный код ответа. |
enum class 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.1/qtcoap.html