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

メッセージ

このモジュールには、OpenThreadメッセージバッファを操作する関数が含まれています。

概要

列挙

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}
列挙型
この列挙は、OpenThreadメッセージの優先度レベルを定義します。

Typedef

otBufferInfo typedef
struct otBufferInfo
この構造は、メッセージバッファ情報を表します。
otMessage typedef
struct otMessage
このタイプは、OpenThreadメッセージバッファの不透明な表現です。
otMessagePriority typedef
この列挙は、OpenThreadメッセージの優先度レベルを定義します。
otMessageSettings typedef
この構造は、メッセージ設定を表します。

関数

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
メッセージにバイトを追加します。
otMessageFree ( otMessage *aMessage)
void
割り当てられたメッセージバッファを解放します。
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
メッセージバッファ情報を取得します。
otMessageGetLength (const otMessage *aMessage)
uint16_t
メッセージの長さをバイト単位で取得します。
otMessageGetOffset (const otMessage *aMessage)
uint16_t
メッセージオフセットをバイト単位で取得します。
otMessageGetRss (const otMessage *aMessage)
int8_t
この関数は、メッセージに関連付けられた平均RSS(受信信号強度)を返します。
otMessageIsLinkSecurityEnabled (const otMessage *aMessage)
bool
この関数は、メッセージに対してリンクセキュリティが有効になっているかどうかを示します。
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage)
void
この関数は、指定されたメッセージキューからメッセージを削除します。
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage)
void
この関数は、指定されたメッセージキューの最後にメッセージを追加します。
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage)
void
この関数は、指定されたメッセージキューの先頭/先頭にメッセージを追加します。
otMessageQueueGetHead ( otMessageQueue *aQueue)
この関数は、キューの先頭にあるメッセージへのポインタを返します。
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage)
この関数は、順方向(先頭から末尾へ)を繰り返すことにより、キュー内の次のメッセージへのポインターを返します。
otMessageQueueInit ( otMessageQueue *aQueue)
void
メッセージキューを初期化します。
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
メッセージからバイトを読み取ります。
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled)
void
この関数は、メッセージが直接送信を使用して転送されるように設定/強制します。
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
メッセージの長さをバイト単位で設定します。
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)
void
メッセージオフセットをバイト単位で設定します。
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
メッセージにバイトを書き込みます。

構造体

otBufferInfo

この構造は、メッセージバッファ情報を表します。

otMessageQueue

この構造は、OpenThreadメッセージキューを表します。

otMessageSettings

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

列挙

otMessagePriority

 otMessagePriority

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

プロパティ
OT_MESSAGE_PRIORITY_HIGH

優先度が高い。

OT_MESSAGE_PRIORITY_LOW

優先度が低い。

OT_MESSAGE_PRIORITY_NORMAL

通常の優先度。

Typedef

otBufferInfo

struct otBufferInfo otBufferInfo

この構造は、メッセージバッファ情報を表します。

otMessage

struct otMessage otMessage

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

otMessagePriority

enum otMessagePriority otMessagePriority

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

otMessageSettings

struct otMessageSettings otMessageSettings

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

関数

otMessageAppend

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

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

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

詳細
パラメーター
[in] aMessage
メッセージバッファへのポインタ。
参照:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

メッセージバッファ情報を取得します。

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

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

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

詳細
パラメーター
[in] aMessage
メッセージバッファへのポインタ。
戻り値
メッセージの長さ(バイト単位)。
参照:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

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

詳細
パラメーター
[in] aMessage
メッセージバッファへのポインタ。
戻り値
メッセージオフセット値。
参照:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

この関数は、メッセージに関連付けられた平均RSS(受信信号強度)を返します。

詳細
戻り値
平均RSS値(dBm単位)または平均RSSが利用できない場合はOT_RADIO_RSSI_INVALID。

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

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

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

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

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

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

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

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

otMessageQueueGetNext

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

この関数は、順方向(先頭から末尾へ)を繰り返すことにより、キュー内の次のメッセージへのポインターを返します。

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

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

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

この関数は、他のotMessageQueue関数の前に、 otMessageQueueインスタンスに対して1回だけotMessageQueueます。初期化される前に他のキューAPIがotMessageQueue使用されている場合、または複数回初期化されている場合、動作は未定義です。

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

otMessageRead

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

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

この関数は、メッセージが直接送信を使用して転送されるように設定/強制します。

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

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

otMessageSetLength

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

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

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

詳細
パラメーター
[in] aMessage
メッセージバッファへのポインタ。
[in] aOffset
バイト単位のオフセット。
参照:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

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