QtCoap Namespace

Qt CoAP モジュール全体で使用される雑多な識別子が含まれています。詳細...

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

型

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

詳細説明

型の説明

enum class 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`	1つ以上の認識できない、または不正なオプションのために、リクエストをサーバーが理解できませんでした。
`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`	リクエストヘッダーフィールドで指定された一つ以上の条件が、サーバーでテストされたときにfalseと評価された。
`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 "All CoAP Nodes" アドレス224.0.1.187（"IPv4 Multicast Address Space Registry "から）。
`QtCoap::MulticastGroup::AllCoapNodesIPv6LinkLocal`	`1`	IPv6 "All CoAP Nodes" link-local scoped addressFF02::FD, from "IPv6 Multicast Address Space Registry".
`QtCoap::MulticastGroup::AllCoapNodesIPv6SiteLocal`	`2`	IPv6 "All CoAP Nodes" site-local scoped addressFF05::FD（"IPv6 Multicast Address Space Registry "から）。

enum QtCoap::Port

この列挙型は、デフォルトの CoAP ポート値を指定します。

定数	値	説明
`QtCoap::DefaultPort`	`5683`	非セキュア伝送に使用されるデフォルトのポート。
`QtCoap::DefaultSecurePort`	`5684`	セキュア伝送に使用されるデフォルトのポート。

enum class QtCoap::ResponseCode

この列挙型は、RFC 7252とRFC 7959 で定義されている CoAP プロトコルからの応答コードを表します。

定数	値	説明
`QtCoap::ResponseCode::EmptyMessage`	`0x00`	空のメッセージに対する応答コード。
`QtCoap::ResponseCode::Created`	`0x41`	リクエストは成功し、新しいリソースが作成されました。この応答コードは HTTP 201 "Created" に対応します。
`QtCoap::ResponseCode::Deleted`	`0x42`	リソースの削除に成功しました。この応答コードは HTTP 204 "No Content" に対応しますが、DELETE や特定の状況では POST のような、リソースが利用できなくなるリクエストへの応答でのみ使用されます。
`QtCoap::ResponseCode::Valid`	`0x43`	この応答コードはHTTP 304 "Not Modified "に関連するが、ETag Optionで与えられたentity-tagで識別される応答が有効であることを示すためだけに使用される。
`QtCoap::ResponseCode::Changed`	`0x44`	リソースは正常に変更された。この応答コードはHTTP 204 "No Content "に対応するが、POSTとPUTリクエストに対する応答でのみ使用される。
`QtCoap::ResponseCode::Content`	`0x45`	リクエストは成功しました。この応答コードはHTTP 200 "OK "に対応しますが、GETリクエストに対する応答でのみ使用されます。
`QtCoap::ResponseCode::Continue`	`0x5F`	現在のブロックの転送が成功したことを示し、サーバーはさらにブロックを送信します。
`QtCoap::ResponseCode::BadRequest`	`0x-80`	リクエストは認識されませんでした。この応答コードはHTTP 400 "Bad Request "に対応する。
`QtCoap::ResponseCode::Unauthorized`	`0x-7f`	クライアントは要求されたアクションを実行する権限がありません。この応答コードはHTTP 401 "Unauthorized "に対応する。
`QtCoap::ResponseCode::BadOption`	`0x-7e`	認識できないオプションのため、リクエストをサーバーが理解できませんでした。
`QtCoap::ResponseCode::Forbidden`	`0x-7d`	このリソースへのアクセスは禁止されています。このレスポンスコードは HTTP 403 "Forbidden" に対応します。
`QtCoap::ResponseCode::NotFound`	`0x-7c`	要求されたリソースが見つからなかった。このレスポンスコードはHTTP 404 "Not Found "に対応します。
`QtCoap::ResponseCode::MethodNotAllowed`	`0x-7b`	要求された URL に使用されたメソッドをサーバーが許可していません。この応答コードはHTTP 405 "Method Not Allowed "に対応するが、"Allow "ヘッダーフィールドと並列ではない。
`QtCoap::ResponseCode::NotAcceptable`	`0x-7a`	リクエストの受け入れ基準を満たすリソースが見つからなかった。この応答コードはHTTP 406 "Not Acceptable "に対応するが、応答実体はない。
`QtCoap::ResponseCode::RequestEntityIncomplete`	`0x-78`	サーバーは、処理を進めるために必要なリクエストボディのすべてのブロックを受け取っていない。
`QtCoap::ResponseCode::PreconditionFailed`	`0x-74`	リクエストヘッダーフィールドで与えられた前提条件が、サーバーでテストされたときに`false` と評価された。この応答コードはHTTP 412 "Precondition Failed "に相当する。
`QtCoap::ResponseCode::RequestEntityTooLarge`	`0x-73`	リクエストのペイロードが、サーバーが処理する意思や能力を超えている。この応答コードはHTTP 413 "Request Entity Too Large "に対応する。
`QtCoap::ResponseCode::UnsupportedContentFormat`	`0x-72`	ペイロードが、ターゲットリソース上でこのメソッドがサポートしないフォーマットである。このレスポンスコードはHTTP 415 "Unsupported Media Type "に対応する。
`QtCoap::ResponseCode::InternalServerFault`	`0x-60`	サーバーがリクエストを処理できない予期せぬ状況に遭遇した。このレスポンスコードはHTTP 500 "Internal Server Error "に対応します。
`QtCoap::ResponseCode::NotImplemented`	`0x-5f`	サーバーがリクエストの処理に必要な機能をサポートしていません。この応答コードは HTTP 501 "Not Implemented" に対応します。
`QtCoap::ResponseCode::BadGateway`	`0x-5e`	上流のサーバーでエラーが発生しました。このレスポンス・コードは HTTP 502 "Bad Gateway" に対応します。
`QtCoap::ResponseCode::ServiceUnavailable`	`0x-5d`	サービスは現在利用できません。この応答コードはHTTP 503 "Service Unavailable "に対応します。
`QtCoap::ResponseCode::GatewayTimeout`	`0x-5c`	サーバーがゲートウェイまたはプロキシとして動作している間に、上流サーバーからタイムリーな応答を受信しませんでした。この応答コードは HTTP 504 "Gateway Timeout" に対応します。
`QtCoap::ResponseCode::ProxyingNotSupported`	`0x-5b`	サーバはProxy-Uri Optionで指定されたURIに対して、あるいはProxy-Schemeで指定されたスキームを使用して、フォワードプロキシとして動作できないか、あるいは動作する気がない。
`QtCoap::ResponseCode::InvalidCode`	`0xFF`	無効な応答コード。

enum class QtCoap::SecurityMode

RFC 7252 で定義されているように、CoAP 接続を保護するために使用されるセキュリティモードを指定する。

定数	値	説明
`QtCoap::SecurityMode::NoSecurity`	`0`	プロトコルレベルのセキュリティはありません（DTLS は無効です）。
`QtCoap::SecurityMode::PreSharedKey`	`1`	DTLS は有効です。セキュリティに PSK 認証が使用される。
`QtCoap::SecurityMode::RawPublicKey`	`2`	DTLS が有効。セキュリティには証明書なしの非対称鍵ペア（生の公開鍵）が使用される。このモードはまだサポートされていない。
`QtCoap::SecurityMode::Certificate`	`3`	DTLSが有効。X.509 証明書付きの非対称鍵ペアがセキュリティに使用されます。

本書に含まれる文書の著作権は、それぞれの所有者に帰属します。本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の商標です。その他すべての商標は、それぞれの所有者に帰属します。