メッセージ

 otMessagePriority

この列挙値は、OpenThread メッセージの優先度レベルを定義します。

プロパティ
OT_MESSAGE_PRIORITY_HIGH	優先度が高い。
OT_MESSAGE_PRIORITY_LOW	低い優先度です。
OT_MESSAGE_PRIORITY_NORMAL	優先度: 標準。

struct otBufferInfo otBufferInfo

この構造体は、OpenThread スタックで使用されるさまざまなキューのメッセージ バッファ情報を表します。

struct otMessage otMessage

この型は、OpenThread メッセージ バッファの不透明表現です。

enum otMessagePriority otMessagePriority

この列挙値は、OpenThread メッセージの優先度レベルを定義します。

struct otMessageQueueInfo otMessageQueueInfo

この構造はメッセージ キューに関する情報を表します。

struct otMessageSettings otMessageSettings

この構造はメッセージの設定を表します。

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

メッセージにバイトを追加する。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aBuf 追加するデータへのポインタ。 [in] aLength 追加するバイト数。
戻り値	OT_ERROR_NONE メッセージに追加しました OT_ERROR_NO_BUFS メッセージを増大させるために使用できるバッファがありません。

関連情報:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageFree(
  otMessage *aMessage
)

割り当てられたメッセージ バッファを解放します。

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

関連情報:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Message Buffer 情報を取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [out] aBufferInfo メッセージ バッファ情報が書き込まれるポインタ。

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

メッセージの長さをバイト単位で取得します。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。
戻り値	メッセージの長さ（バイト単位）。

関連情報:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

メッセージのオフセットをバイト単位で取得します。

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

関連情報:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

int8_t otMessageGetRss(
  const otMessage *aMessage
)

この関数は、メッセージに関連付けられている平均 RSS（受信信号強度）を返します。

詳細
戻り値	RSS の平均値（dBm）。平均 RSS を利用できない場合は OT_RADIO_RSSI_INVALID。

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

メッセージに対してリンク セキュリティが有効になっているかどうかを示します。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。
戻り値	TRUE リンクのセキュリティが有効になっている場合。 FALSE リンクのセキュリティが有効になっていない場合。

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

この関数は、指定されたメッセージ キューからメッセージを削除します。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。 [in] aMessage 削除するメッセージ。

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

この関数は、指定されたメッセージ キューの末尾にメッセージを追加します。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。 [in] aMessage 追加するメッセージ。

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

この関数は、指定されたメッセージ キューの先頭にメッセージを追加します。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。 [in] aMessage 追加するメッセージ。

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

この関数は、キューの先頭にあるメッセージへのポインタを返します。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。
戻り値	キューの先頭にあるメッセージへのポインタ。キューが空の場合は NULL。

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

この関数は、前方（ヘッドからテール）まで反復処理して、キュー内の次のメッセージへのポインタを返します。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。 [in] aMessage 現在のメッセージ バッファへのポインタ。
戻り値	aMessage の後のキュー内の次のメッセージへのポインタ。aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue` の場合は NULL。

void otMessageQueueInit(
  otMessageQueue *aQueue
)

メッセージ キューを初期化します。

この関数は、otMessageQueue他のどのインスタンスよりも前にotMessageQueue関数を使用しています。初期化前に他のキュー API が otMessageQueue で使用された場合、または複数回初期化された場合、この動作は未定義になります。

詳細
パラメータ	[in] aQueue メッセージ キューへのポインタ。

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

メッセージからバイトを読み取ります。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aOffset オフセット（バイト単位）。 [in] aBuf メッセージ バイトが読み取られるバッファへのポインタ。 [in] aLength 読み込むバイト数。
戻り値	読み取られたバイト数。

関連情報:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

この関数では、ダイレクト送信を使用して、メッセージが転送または設定されます。

新しいメッセージのデフォルト設定は false です。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aEnabled true の場合、メッセージは直接送信を使用します。false の場合、メッセージは通常のプロセスに従います。

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

メッセージの長さをバイト単位で設定します。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aLength 長さ（バイト単位）。
戻り値	OT_ERROR_NONE メッセージの長さを設定しました。 OT_ERROR_NO_BUFS メッセージを増大させるために使用できるバッファがありません。

関連情報:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

メッセージのオフセットをバイト単位で設定します。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aOffset オフセット（バイト単位）。

関連情報:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

メッセージにバイトを書き込む。

詳細
パラメータ	[in] aMessage メッセージ バッファへのポインタ。 [in] aOffset オフセット（バイト単位）。 [in] aBuf メッセージ バイトの書き込み元のバッファへのポインタ。 [in] aLength 書き込むバイト数。
戻り値	書き込まれたバイト数。

関連情報:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead