Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

CoAP

このモジュールには、CoAP通信を制御する機能が含まれています。

概要

CoAPのAPI機能(ときに、このモジュールの関数が用意されていますOPENTHREAD_CONFIG_COAP_API_ENABLE )有効になっています。

列挙

otCoapBlockSzx列挙型
CoAPブロックサイズの指数。
otCoapCode {
OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
}
列挙型
CoAPコード値。
otCoapOptionContentFormat {
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
}
列挙型
CoAPコンテンツフォーマットコード。
otCoapOptionType {
OT_COAP_OPTION_IF_MATCH = 1,
OT_COAP_OPTION_URI_HOST = 3,
OT_COAP_OPTION_E_TAG = 4,
OT_COAP_OPTION_IF_NONE_MATCH = 5,
OT_COAP_OPTION_OBSERVE = 6,
OT_COAP_OPTION_URI_PORT = 7,
OT_COAP_OPTION_LOCATION_PATH = 8,
OT_COAP_OPTION_URI_PATH = 11,
OT_COAP_OPTION_CONTENT_FORMAT = 12,
OT_COAP_OPTION_MAX_AGE = 14,
OT_COAP_OPTION_URI_QUERY = 15,
OT_COAP_OPTION_ACCEPT = 17,
OT_COAP_OPTION_LOCATION_QUERY = 20,
OT_COAP_OPTION_BLOCK2 = 23,
OT_COAP_OPTION_BLOCK1 = 27,
OT_COAP_OPTION_SIZE2 = 28,
OT_COAP_OPTION_PROXY_URI = 35,
OT_COAP_OPTION_PROXY_SCHEME = 39,
OT_COAP_OPTION_SIZE1 = 60
}
列挙型
CoAPオプション番号。
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
列挙型
CoAPタイプ値(2ビットの符号なし整数)。

Typedef

otCoapBlockSzx typedef
CoAPブロックサイズの指数。
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
この関数ポインタは、ブロック単位の転送オプションを含むCoAPメッセージが受信されたときに呼び出されます。
otCoapBlockwiseResource typedef
この構造は、ブロック単位の転送を伴うCoAPリソースを表します。
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
この関数ポインタは、ブロック単位の転送の次のブロックが送信される前に呼び出されます。
otCoapCode typedef
CoAPコード値。
otCoapOption typedef
struct otCoapOption
この構造はCoAPオプションを表します。
otCoapOptionContentFormat typedef
CoAPコンテンツフォーマットコード。
otCoapOptionIterator typedef
この構造は、CoAPオプションのイテレーターとして機能します。
otCoapOptionType typedef
CoAPオプション番号。
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
この関数ポインターは、特定のURIパスを使用したCoAP要求が受信されたときに呼び出されます。
otCoapResource typedef
この構造はCoAPリソースを表します。
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
この関数ポインタは、CoAP応答が受信されたとき、または要求がタイムアウトしたときに呼び出されます。
otCoapTxParameters typedef
この構造は、CoAP送信パラメータを表します。
otCoapType typedef
CoAPタイプ値(2ビットの符号なし整数)。

関数

otCoapAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
この関数は、ブロック単位のリソースをCoAPサーバーに追加します。
otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
この関数は、CoAPサーバーにリソースを追加します。
otCoapBlockSizeFromExponent ( otCoapBlockSzx aSize)
uint16_t
この関数は、CoAPブロックオプションのSZXフィールドを実際のブロックサイズに変換します。
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
この関数は、Block1オプションを追加します。
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
この関数は、Block2オプションを追加します。
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
指定されているこの機能は、コンテンツのフォーマットCoAPオプションを追加しhttps://tools.ietf.org/html/rfc7252#page-92
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)
この関数は、Max-Ageオプションを追加します。
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)
この関数は、監視オプションを追加します。
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
この関数は、ヘッダーにCoAPオプションを追加します。
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath)
この関数は、Proxy-Uriオプションを追加します。
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
指定されているこの機能は、符号なし整数CoAPオプションを追加しhttps://tools.ietf.org/html/rfc7252#section-3.2
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath)
この関数は、Uri-Pathオプションを追加します。
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery)
この関数は、単一のURIクエリオプションを追加します。
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
このメソッドは、CoAPコードを人間が読める文字列として返します。
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)
void
この関数は、トークンの長さを設定し、その値をランダム化します。
otCoapMessageGetCode (const otMessage *aMessage)
この関数はコード値を返します。
otCoapMessageGetMessageId (const otMessage *aMessage)
uint16_t
この関数はメッセージID値を返します。
otCoapMessageGetToken (const otMessage *aMessage)
const uint8_t *
この関数は、トークン値へのポインタを返します。
otCoapMessageGetTokenLength (const otMessage *aMessage)
uint8_t
この関数はトークンの長さを返します。
otCoapMessageGetType (const otMessage *aMessage)
この関数はType値を返します。
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
この関数は、CoAPヘッダーを初期化します。
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
この関数は、応答メッセージを初期化します。
otCoapMessageSetPayloadMarker ( otMessage *aMessage)
この関数は、ペイロードの開始を示すペイロードマーカーをCoAPヘッダーに追加します。
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
この関数は、ヘッダーにトークンの値と長さを設定します。
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
この関数は、新しいCoAPメッセージを作成します。
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
この関数は、最初のオプションへのポインタを返します。
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
この関数は、指定されたオプション番号に一致する最初のオプションへのポインタを返します。
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
この関数は、次のオプションへのポインタを返します。
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
この関数は、指定されたオプション番号に一致する次のオプションへのポインタを返します。
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *aValue)
この関数は、に現在のオプション値を満たすaValue電流値がに従って符号化の符号なし整数であると仮定https://tools.ietf.org/html/rfc7252#section-3.2
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue)
この関数は、に現在のオプション値を満たすaValue
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage)
この関数は、指定されたメッセージのオプションのイテレータを初期化します。
otCoapRemoveBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
この関数は、CoAPサーバーからブロック単位のリソースを削除します。
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
この関数は、CoAPサーバーからリソースを削除します。
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
この関数はCoAPリクエストを送信します。
otCoapSendRequestBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
この関数は、CoAP要求をブロック単位で送信します。
otCoapSendRequestBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
この関数は、カスタム送信パラメーターを使用してブロック単位でCoAP要求を送信します。
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
この関数は、カスタム送信パラメーターを使用してCoAP要求を送信します。
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
この関数は、サーバーからCoAP応答を送信します。
otCoapSendResponseBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
この関数は、サーバーからブロック単位でCoAP応答を送信します。
otCoapSendResponseBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
この関数は、カスタム送信パラメーターを使用して、サーバーからブロック単位でCoAP応答を送信します。
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
この関数は、カスタム送信パラメーターを使用してサーバーからCoAP応答を送信します。
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
この関数は、未処理のCoAPリクエストのデフォルトハンドラーを設定します。
otCoapStart ( otInstance *aInstance, uint16_t aPort)
この関数はCoAPサーバーを起動します。
otCoapStop ( otInstance *aInstance)
この関数はCoAPサーバーを停止します。

構造体

otCoapBlockwiseResource

この構造は、ブロック単位の転送を伴うCoAPリソースを表します。

otCoapOption

この構造はCoAPオプションを表します。

otCoapOptionIterator

この構造は、CoAPオプションのイテレーターとして機能します。

otCoapResource

この構造はCoAPリソースを表します。

otCoapTxParameters

この構造は、CoAP送信パラメータを表します。

列挙

otCoapBlockSzx

 otCoapBlockSzx

CoAPブロックサイズの指数。

otCoapCode

 otCoapCode

CoAPコード値。

プロパティ
OT_COAP_CODE_BAD_GATEWAY

悪いゲートウェイ。

OT_COAP_CODE_BAD_OPTION

悪いオプション。

OT_COAP_CODE_BAD_REQUEST

要求の形式が正しくありません。

OT_COAP_CODE_CHANGED

かわった。

OT_COAP_CODE_CONTENT

コンテンツ。

OT_COAP_CODE_CONTINUE

RFC7959続行します。

OT_COAP_CODE_CREATED

作成した。

OT_COAP_CODE_DELETE

消去。

OT_COAP_CODE_DELETED

削除されました。

OT_COAP_CODE_EMPTY

空のメッセージコード。

OT_COAP_CODE_FORBIDDEN

禁断。

OT_COAP_CODE_GATEWAY_TIMEOUT

ゲートウェイタイムアウト。

OT_COAP_CODE_GET

取得する。

OT_COAP_CODE_INTERNAL_ERROR

内部サーバーエラー。

OT_COAP_CODE_METHOD_NOT_ALLOWED

方法は許可されていません。

OT_COAP_CODE_NOT_ACCEPTABLE

受け付けできません。

OT_COAP_CODE_NOT_FOUND

見つかりません。

OT_COAP_CODE_NOT_IMPLEMENTED

実装されていません。

OT_COAP_CODE_POST

役職。

OT_COAP_CODE_PRECONDITION_FAILED

前提条件が失敗しました。

OT_COAP_CODE_PROXY_NOT_SUPPORTED

プロキシはサポートされていません。

OT_COAP_CODE_PUT

置く。

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959リクエストエンティティが不完全です。

OT_COAP_CODE_REQUEST_TOO_LARGE

エンティティが大きすぎるリクエスト。

OT_COAP_CODE_RESPONSE_MIN

2.00

OT_COAP_CODE_SERVICE_UNAVAILABLE

サービスは利用できません。

OT_COAP_CODE_UNAUTHORIZED

許可されていません。

OT_COAP_CODE_UNSUPPORTED_FORMAT

サポートされていないコンテンツ形式。

OT_COAP_CODE_VALID

有効。

otCoapOptionContentFormat

 otCoapOptionContentFormat

CoAPコンテンツフォーマットコード。

完全なリストはで文書化されてhttps://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

プロパティ
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

アプリケーション/ cbor:[RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application / coap-group + json:[RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

アプリケーション/ケース; cose-type = "cose-encrypt":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

アプリケーション/ケース; cose-type = "cose-encrypt0":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

アプリケーション/ cose-key:[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

アプリケーション/ cose-key-set:[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

アプリケーション/ケース; cose-type = "cose-mac":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

アプリケーション/ケース; cose-type = "cose-mac0":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

アプリケーション/ケース; cose-type = "cose-sign":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

アプリケーション/ケース; cose-type = "cose-sign1":[RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

application / cwt:[RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application / exi:["Efficient XML Interchange(EXI)Format 1.0(Second Edition)"、2014年2月]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

アプリケーション/ json:[RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application / json-patch + json:[RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

アプリケーション/リンク形式:[RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

application / merge-patch + json:[RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

アプリケーション/オクテットストリーム:[RFC2045] [RFC2046]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR

application / senml + cbor:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

application / senml-exi:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

application / senml + json:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

application / senml + xml:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR

application / sensml + cbor:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI

application / sensml-exi:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON

application / sensml + json:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML

application / sensml + xml:[RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN

テキスト/プレーン; charset = utf-8:[RFC2046] [RFC3676] [RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

application / xml:[RFC3023]

otCoapOptionType

 otCoapOptionType

CoAPオプション番号。

プロパティ
OT_COAP_OPTION_ACCEPT

承認。

OT_COAP_OPTION_BLOCK1

ブロック1(RFC7959)

OT_COAP_OPTION_BLOCK2

ブロック2(RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

コンテンツフォーマット。

OT_COAP_OPTION_E_TAG

ETag。

OT_COAP_OPTION_IF_MATCH

一致する場合。

OT_COAP_OPTION_IF_NONE_MATCH

If-None-Match。

OT_COAP_OPTION_LOCATION_PATH

場所-パス。

OT_COAP_OPTION_LOCATION_QUERY

場所-クエリ。

OT_COAP_OPTION_MAX_AGE

最大年齢。

OT_COAP_OPTION_OBSERVE

[RFC7641]を観察してください。

OT_COAP_OPTION_PROXY_SCHEME

プロキシスキーム。

OT_COAP_OPTION_PROXY_URI

プロキシURI。

OT_COAP_OPTION_SIZE1

サイズ1。

OT_COAP_OPTION_SIZE2

サイズ2(RFC7959)

OT_COAP_OPTION_URI_HOST

Uri-ホスト。

OT_COAP_OPTION_URI_PATH

ウリパス。

OT_COAP_OPTION_URI_PORT

ウリポート。

OT_COAP_OPTION_URI_QUERY

URIクエリ。

otCoapType

 otCoapType

CoAPタイプ値(2ビットの符号なし整数)。

プロパティ
OT_COAP_TYPE_ACKNOWLEDGMENT

了承。

OT_COAP_TYPE_CONFIRMABLE

確認可能。

OT_COAP_TYPE_NON_CONFIRMABLE

確認できません。

OT_COAP_TYPE_RESET

リセットします。

Typedef

otCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

CoAPブロックサイズの指数。

otCoapBlockwiseReceiveHook

otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)

この関数ポインタは、ブロック単位の転送オプションを含むCoAPメッセージが受信されたときに呼び出されます。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

詳細
パラメーター
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
[in] aBlock
ブロックセグメントへのポインタ。
[in] aPosition
位置aBlockバイトのシーケンスです。
[in] aBlockLength
ブロックセグメントの長さ(バイト単位)。
[in] aMore
さらにブロックセグメントが続く場合はフラグを立てます。
[in] aTotalLength
転送された情報の全長(バイト単位)(Size1またはSize2オプションで示されます)。
戻り値
OT_ERROR_NONE
ブロックセグメントは正常に保存されました。
OT_ERROR_NO_BUFS
ブロックを保存するためのメモリはもうありません。
OT_ERROR_NO_FRAME_RECEIVED
ブロックセグメントがありません。

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

この構造は、ブロック単位の転送を伴うCoAPリソースを表します。

otCoapBlockwiseTransmitHook

otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)

この関数ポインタは、ブロック単位の転送の次のブロックが送信される前に呼び出されます。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

aBlockLengthの値を変更することにより、交換全体のブロックサイズが再ネゴシエートされます。後で変更すると他のCoAP実装で問題が発生する可能性があるため、最初のブロックを受信した後でこれを行うことをお勧めします。

詳細
パラメーター
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
[in,out] aBlock
ブロックセグメントを書き込むことができる場所へのポインタ。
[in] aPosition
ブロックセグメントを取得するシーケンス内の位置。
[in,out] aBlockLength
入力時の最大ブロックセグメント長(バイト単位)。
[out] aMore
さらにブロックセグメントが続く場合は、フラグへのポインタ。
戻り値
OT_ERROR_NONE
エラーは発生しませんでした。
OT_ERROR_INVALID_ARGS
ブロックaPosition存在しません。

otCoapCode

enum otCoapCode otCoapCode

CoAPコード値。

otCoapOption

struct otCoapOption otCoapOption

この構造はCoAPオプションを表します。

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

CoAPコンテンツフォーマットコード。

完全なリストはで文書化されてhttps://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

この構造は、CoAPオプションのイテレーターとして機能します。

otCoapOptionType

enum otCoapOptionType otCoapOptionType

CoAPオプション番号。

otCoapRequestHandler

void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

この関数ポインターは、特定のURIパスを使用したCoAP要求が受信されたときに呼び出されます。

詳細
パラメーター
[in] aContext
任意のコンテキスト情報へのポインタ。
[in] aMessage
メッセージへのポインタ。
[in] aMessageInfo
以下のためのメッセージ情報へのポインタaMessage

otCoapResource

struct otCoapResource otCoapResource

この構造はCoAPリソースを表します。

otCoapResponseHandler

void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)

この関数ポインタは、CoAP応答が受信されたとき、または要求がタイムアウトしたときに呼び出されます。

詳細
パラメーター
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
[in] aMessage
応答を含むメッセージバッファへのポインタ。応答がない場合はNULL。
[in] aMessageInfo
以下のためのメッセージ情報へのポインタaMessage 。応答がない場合はNULL。
[in] aResult
CoAPトランザクションの結果。
戻り値
OT_ERROR_NONE
応答が正常に受信されました。
OT_ERROR_ABORT
CoAPトランザクションがピアによってリセットされました。
OT_ERROR_RESPONSE_TIMEOUT
タイムアウト期間中に応答または確認応答を受信しませんでした。

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

この構造は、CoAP送信パラメータを表します。

otCoapType

enum otCoapType otCoapType

CoAPタイプ値(2ビットの符号なし整数)。

関数

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

この関数は、ブロック単位のリソースをCoAPサーバーに追加します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aResource
リソースへのポインタ。

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

この関数は、CoAPサーバーにリソースを追加します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aResource
リソースへのポインタ。

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

この関数は、CoAPブロックオプションのSZXフィールドを実際のブロックサイズに変換します。

詳細
パラメーター
[in] aSize
ブロックサイズの指数。
戻り値
実際のサイズの指数値。

otCoapMessageAppendBlock1Option

otError otCoapMessageAppendBlock1Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

この関数は、Block1オプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aNum
現在のブロック番号。
[in] aMore
より多くのブロックが送信されることを示すブール値。
[in] aSize
ブロックサイズ指数。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendBlock2Option

otError otCoapMessageAppendBlock2Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

この関数は、Block2オプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aNum
現在のブロック番号。
[in] aMore
より多くのブロックが送信されることを示すブール値。
[in] aSize
ブロックサイズ指数。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

指定されているこの機能は、コンテンツのフォーマットCoAPオプションを追加しhttps://tools.ietf.org/html/rfc7252#page-92

これは、ペイロードがメッセージに含まれるようにする場合はotCoapMessageSetPayloadMarkerを設定する前に呼び出さなければなりません

この関数はotCoapMessageAppendUintOptionの便利なラッパーであり、目的の形式タイプコードがotCoapOptionContentFormatにリストされていない場合は、代わりにこの基本関数を使用する必要があります。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aContentFormat
上記のotCoapOptionContentFormatにリストされているコンテンツ形式の1つ。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

この関数は、Max-Ageオプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aMaxAge
Max-Age値。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

この関数は、監視オプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aObserve
フィールド値を観察します。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendOption

otError otCoapMessageAppendOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint16_t aLength,
  const void *aValue
)

この関数は、ヘッダーにCoAPオプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aNumber
CoAPオプション番号。
[in] aLength
CoAPオプションの長さ。
[in] aValue
CoAP値へのポインター。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendProxyUriOption

otError otCoapMessageAppendProxyUriOption(
  otMessage *aMessage,
  const char *aUriPath
)

この関数は、Proxy-Uriオプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aUriPath
NULLで終了する文字列へのポインタ。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendUintOption

otError otCoapMessageAppendUintOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint32_t aValue
)

指定されているこの機能は、符号なし整数CoAPオプションを追加しhttps://tools.ietf.org/html/rfc7252#section-3.2

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aNumber
CoAPオプション番号。
[in] aValue
CoAPオプションの符号なし整数値。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。
参照:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

otError otCoapMessageAppendUriPathOptions(
  otMessage *aMessage,
  const char *aUriPath
)

この関数は、Uri-Pathオプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aUriPath
NULLで終了する文字列へのポインタ。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageAppendUriQueryOption

otError otCoapMessageAppendUriQueryOption(
  otMessage *aMessage,
  const char *aUriQuery
)

この関数は、単一のURIクエリオプションを追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aUriQuery
NULLで終了する文字列へのポインタ。これには、単一のキーと値のペアが含まれている必要があります。
戻り値
OT_ERROR_NONE
オプションが正常に追加されました。
OT_ERROR_INVALID_ARGS
オプションタイプが最後のオプションタイプ以上ではありません。
OT_ERROR_NO_BUFS
オプションの長さがバッファサイズを超えています。

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

このメソッドは、CoAPコードを人間が読める文字列として返します。

@はCoAPコードを文字列として返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

この関数は、トークンの長さを設定し、その値をランダム化します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aTokenLength
設定するトークンの長さ。

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

この関数はコード値を返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
コード値。

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

この関数はメッセージID値を返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
メッセージIDの値。

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

この関数は、トークン値へのポインタを返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
トークン値へのポインタ。

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

この関数はトークンの長さを返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
トークンの長さ。

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

この関数はType値を返します。

詳細
パラメーター
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
タイプ値。

otCoapMessageInit

void otCoapMessageInit(
  otMessage *aMessage,
  otCoapType aType,
  otCoapCode aCode
)

この関数は、CoAPヘッダーを初期化します。

詳細
パラメーター
[in,out] aMessage
初期化するCoAPメッセージへのポインタ。
[in] aType
CoAPメッセージタイプ。
[in] aCode
CoAPメッセージコード。

otCoapMessageInitResponse

otError otCoapMessageInitResponse(
  otMessage *aResponse,
  const otMessage *aRequest,
  otCoapType aType,
  otCoapCode aCode
)

この関数は、応答メッセージを初期化します。

詳細
パラメーター
[in,out] aResponse
CoAP応答メッセージへのポインタ。
[in] aRequest
CoAP要求メッセージへのポインター。
[in] aType
CoAPメッセージタイプ。
[in] aCode
CoAPメッセージコード。
戻り値
OT_ERROR_NONE
応答メッセージが正常に初期化されました。
OT_ERROR_NO_BUFS
応答メッセージを初期化するために使用できるメッセージバッファが不十分です。

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

この関数は、ペイロードの開始を示すペイロードマーカーをCoAPヘッダーに追加します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
戻り値
OT_ERROR_NONE
ペイロードマーカーが正常に追加されました。
OT_ERROR_NO_BUFS
ヘッダーペイロードマーカーがバッファーサイズを超えています。

otCoapMessageSetToken

otError otCoapMessageSetToken(
  otMessage *aMessage,
  const uint8_t *aToken,
  uint8_t aTokenLength
)

この関数は、ヘッダーにトークンの値と長さを設定します。

詳細
パラメーター
[in,out] aMessage
CoAPメッセージへのポインタ。
[in] aToken
トークン値へのポインタ。
[in] aTokenLength
長さaToken
戻り値
OT_ERROR_NONE
トークン値を正常に設定しました。
OT_ERROR_NO_BUFS
トークン値を設定するためのバッファが不十分です。

otCoapNewMessage

otMessage * otCoapNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

この関数は、新しいCoAPメッセージを作成します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSettings
メッセージ設定へのポインタ、またはデフォルト設定を設定するためのNULL。
戻り値
メッセージバッファへのポインタ。使用可能なメッセージバッファがないか、パラメータが無効な場合はNULL。

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

この関数は、最初のオプションへのポインタを返します。

詳細
パラメーター
[in,out] aIterator
CoAPメッセージオプションイテレータへのポインタ。
戻り値
最初のオプションへのポインタ。オプションが存在しない場合、NULLポインタが返されます。

otCoapOptionIteratorGetFirstOptionMatching

const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

この関数は、指定されたオプション番号に一致する最初のオプションへのポインタを返します。

詳細
パラメーター
[in] aIterator
CoAPメッセージオプションイテレータへのポインタ。
[in] aOption
求められたオプション番号。
戻り値
最初に一致するオプションへのポインタ。一致するオプションが存在しない場合、NULLポインタが返されます。

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

この関数は、次のオプションへのポインタを返します。

詳細
パラメーター
[in,out] aIterator
CoAPメッセージオプションイテレータへのポインタ。
戻り値
次のオプションへのポインタ。これ以上オプションが存在しない場合は、NULLポインターが返されます。

otCoapOptionIteratorGetNextOptionMatching

const otCoapOption * otCoapOptionIteratorGetNextOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

この関数は、指定されたオプション番号に一致する次のオプションへのポインタを返します。

詳細
パラメーター
[in] aIterator
CoAPメッセージオプションイテレータへのポインタ。
[in] aOption
求められたオプション番号。
戻り値
次の一致するオプションへのポインタ。それ以上一致するオプションが存在しない場合、NULLポインターが返されます。

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

この関数は、に現在のオプション値を満たすaValue電流値がに従って符号化の符号なし整数であると仮定https://tools.ietf.org/html/rfc7252#section-3.2

詳細
パラメーター
[in,out] aIterator
CoAPメッセージオプションイテレータへのポインタ。
[out] aValue
オプション値を受け取るための符号なし整数へのポインタ。
戻り値
OT_ERROR_NONE
値を正常に入力しました。
OT_ERROR_NOT_FOUND
現在のオプションはありません。
OT_ERROR_NO_BUFS
値が長すぎてuint64_tに収まりません。
参照:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

この関数は、に現在のオプション値を満たすaValue

詳細
パラメーター
[in,out] aIterator
CoAPメッセージオプションイテレータへのポインタ。
[out] aValue
オプション値を受け取るためのバッファーへのポインター。
戻り値
OT_ERROR_NONE
値を正常に入力しました。
OT_ERROR_NOT_FOUND
現在のオプションはありません。

otCoapOptionIteratorInit

otError otCoapOptionIteratorInit(
  otCoapOptionIterator *aIterator,
  const otMessage *aMessage
)

この関数は、指定されたメッセージのオプションのイテレータを初期化します。

詳細
パラメーター
[in,out] aIterator
CoAPメッセージオプションイテレータへのポインタ。
[in] aMessage
CoAPメッセージへのポインタ。
戻り値
OT_ERROR_NONE
正常に初期化されました。
OT_ERROR_PARSE
メッセージの状態に一貫性がありません。

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

この関数は、CoAPサーバーからブロック単位のリソースを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aResource
リソースへのポインタ。

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

この関数は、CoAPサーバーからリソースを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aResource
リソースへのポインタ。

otCoapSendRequest

otError otCoapSendRequest(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext
)

この関数はCoAPリクエストを送信します。

要求に対する応答が予想される場合は、それぞれの機能およびコンテキスト情報を提供する必要があります。応答が期待されない場合、これらの引数はNULLポインターである必要があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するメッセージへのポインタ。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aHandler
応答の受信またはタイムアウト時に呼び出される関数ポインタ。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
戻り値
OT_ERROR_NONE
CoAPメッセージを正常に送信しました。
OT_ERROR_NO_BUFS
再送信データの割り当てに失敗しました。

otCoapSendRequestBlockWise

otError otCoapSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

この関数は、CoAP要求をブロック単位で送信します。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

要求に対する応答が予想される場合は、それぞれの機能およびコンテキスト情報を提供する必要があります。応答がブロック単位であると予想される場合は、それぞれのフック関数を提供する必要があります。応答が期待されない場合、これらの引数はNULLポインターである必要があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するメッセージへのポインタ。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aHandler
応答の受信またはタイムアウト時に呼び出される関数ポインタ。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
[in] aTransmitHook
発信ブロックワイズ転送用のフック関数へのポインタ。
[in] aReceiveHook
着信ブロックワイズ転送用のフック関数へのポインタ。
戻り値
OT_ERROR_NONE
CoAPメッセージを正常に送信しました。
OT_ERROR_NO_BUFS
再送信データの割り当てに失敗しました。

otCoapSendRequestBlockWiseWithParameters

otError otCoapSendRequestBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

この関数は、カスタム送信パラメーターを使用してブロック単位でCoAP要求を送信します。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

要求に対する応答が予想される場合は、それぞれの機能およびコンテキスト情報を提供する必要があります。応答がブロック単位であると予想される場合は、それぞれのフック関数を提供する必要があります。応答が期待されない場合、これらの引数はNULLポインターである必要があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するメッセージへのポインタ。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aHandler
応答の受信またはタイムアウト時に呼び出される関数ポインタ。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
[in] aTxParameters
このリクエストの送信パラメータへのポインタ。デフォルトにはNULLを使用します。
[in] aTransmitHook
発信ブロックワイズ転送用のフック関数へのポインタ。
[in] aReceiveHook
着信ブロックワイズ転送用のフック関数へのポインタ。
戻り値
OT_ERROR_NONE
CoAPメッセージを正常に送信しました。
OT_ERROR_NO_BUFS
再送信データの割り当てに失敗しました。

otCoapSendRequestWithParameters

otError otCoapSendRequestWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters
)

この関数は、カスタム送信パラメーターを使用してCoAP要求を送信します。

要求に対する応答が予想される場合は、それぞれの機能およびコンテキスト情報を提供する必要があります。応答が期待されない場合、これらの引数はNULLポインターである必要があります。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するメッセージへのポインタ。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aHandler
応答の受信またはタイムアウト時に呼び出される関数ポインタ。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
[in] aTxParameters
このリクエストの送信パラメータへのポインタ。デフォルトにはNULLを使用します。それ以外の場合、指定されたパラメーターは次の条件を満たす必要があります。
  1. mMaxRetransmitはOT_COAP_MAX_RETRANSMITにすぎません。
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominatorは1.0未満であってはなりません。
  3. 計算された交換寿命は、uint32_tをオーバーフローしてはなりません。
戻り値
OT_ERROR_INVALID_ARGS
aTxParameters無効です。
OT_ERROR_NONE
CoAPメッセージを正常に送信しました。
OT_ERROR_NO_BUFS
再送信データの割り当てに失敗しました。

otCoapSendResponse

otError otCoapSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

この関数は、サーバーからCoAP応答を送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するCoAP応答へのポインター。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
戻り値
OT_ERROR_NONE
CoAP応答メッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
CoAP応答を送信するために使用できるバッファーが不十分です。

otCoapSendResponseBlockWise

otError otCoapSendResponseBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

この関数は、サーバーからブロック単位でCoAP応答を送信します。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するCoAP応答へのポインター。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
[in] aTransmitHook
発信ブロックワイズ転送用のフック関数へのポインタ。
戻り値
OT_ERROR_NONE
CoAP応答メッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
CoAP応答を送信するために使用できるバッファーが不十分です。

otCoapSendResponseBlockWiseWithParameters

otError otCoapSendResponseBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

この関数は、カスタム送信パラメーターを使用して、サーバーからブロック単位でCoAP応答を送信します。

この関数は、OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE構成が有効になっている場合に使用できます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するCoAP応答へのポインター。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aTxParameters
この応答の送信パラメータへのポインタ。デフォルトにはNULLを使用します。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。
[in] aTransmitHook
発信ブロックワイズ転送用のフック関数へのポインタ。
戻り値
OT_ERROR_NONE
CoAP応答メッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
CoAP応答を送信するために使用できるバッファーが不十分です。

otCoapSendResponseWithParameters

otError otCoapSendResponseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters
)

この関数は、カスタム送信パラメーターを使用してサーバーからCoAP応答を送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
送信するCoAP応答へのポインター。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
[in] aTxParameters
この応答の送信パラメータへのポインタ。デフォルトにはNULLを使用します。
戻り値
OT_ERROR_NONE
CoAP応答メッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
CoAP応答を送信するために使用できるバッファーが不十分です。

otCoapSetDefaultHandler

void otCoapSetDefaultHandler(
  otInstance *aInstance,
  otCoapRequestHandler aHandler,
  void *aContext
)

この関数は、未処理のCoAPリクエストのデフォルトハンドラーを設定します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aHandler
未処理の要求が到着したときに呼び出される関数ポインタ。
[in] aContext
任意のコンテキスト情報へのポインタ。使用しない場合はNULLになる可能性があります。

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

この関数はCoAPサーバーを起動します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPort
バインドするローカルUDPポート。
戻り値
OT_ERROR_NONE
CoAPサーバーを正常に起動しました。
OT_ERROR_FAILED
CoAPサーバーの起動に失敗しました。

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

この関数は、CoAPサーバーを停止します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
OT_ERROR_NONE
CoAPサーバーを正常に停止しました。

マクロ

OT_COAP_CODE

 OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))

CoAPコード値を定義するためのヘルパーマクロ。

OT_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

デフォルトのトークンの長さ。

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

OpenThreadでサポートされる最大再送信。

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

指定された最大トークン長(RFC 7252)。

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

OpenThreadでサポートされているミリ秒単位の最小ACKタイムアウト。

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

RFC7252で指定されているデフォルトのCoAPポート。