QtCoap Namespace

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

ヘッダー:	`#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`	リクエストヘッダーフィールドに指定された 1 つ以上の条件が、サーバー上で検証された際に 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 マルチキャストアドレス空間レジストリ」に由来する、IPv4「すべての CoAP ノード」アドレス224.0.1.187。
`QtCoap::MulticastGroup::AllCoapNodesIPv6LinkLocal`	`1`	「IPv6 マルチキャストアドレス空間レジストリ」に由来する、IPv6 「すべての CoAP ノード」のリンクローカルスコープアドレスFF02::FD。
`QtCoap::MulticastGroup::AllCoapNodesIPv6SiteLocal`	`2`	「IPv6 マルチキャストアドレス空間レジストリ」からの、IPv6「すべての CoAP ノード」サイトローカルスコープアドレスFF05::FD。

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 オプションで指定されたエンティティタグによって識別されるレスポンスが有効であることを示す場合にのみ使用されます。
`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「前提条件の失敗」に対応しますが、リクエストペイロードがサーバーが処理できる範囲を超えているためです。
`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「未実装」に対応します。
`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オプションで指定された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証明書付きの非対称鍵ペアが使用されます。

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.