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

UDP

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

概要

列挙

otNetifIdentifier {
OT_NETIF_UNSPECIFIED = 0,
OT_NETIF_THREAD ,
OT_NETIF_BACKBONE
}
列挙型
この列挙は、OpenThreadネットワークインターフェイス識別子を定義します。

Typedef

otNetifIdentifier typedef
この列挙は、OpenThreadネットワークインターフェイス識別子を定義します。
otUdpHandler )(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
このコールバックにより、OpenThreadは特定のUDPメッセージに特定のハンドラーを提供できます。
otUdpReceive )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
このコールバックにより、OpenThreadは受信したUDPメッセージをアプリケーションに通知できます。
otUdpReceiver typedef
この構造はUDPレシーバーを表します。
otUdpSocket typedef
struct otUdpSocket
この構造はUDPソケットを表します。

関数

otUdpAddReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver)
この関数は、UDPレシーバーを追加します。
otUdpBind ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
UDP / IPv6ソケットをバインドします。
otUdpClose ( otInstance *aInstance, otUdpSocket *aSocket)
UDP / IPv6ソケットを閉じます。
otUdpConnect ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
UDP / IPv6ソケットを接続します。
otUdpGetSockets ( otInstance *aInstance)
この関数は、UDPソケットのリンクリストの先頭を取得します。
otUdpIsOpen ( otInstance *aInstance, const otUdpSocket *aSocket)
bool
UDPソケットが開いているかどうかを確認します。
otUdpNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
UDPメッセージを送信するための新しいメッセージバッファを割り当てます。
otUdpOpen ( otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
UDP / IPv6ソケットを開きます。
otUdpRemoveReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver)
この関数は、UDPレシーバーを削除します。
otUdpSend ( otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
UDP / IPv6メッセージを送信します。
otUdpSendDatagram ( otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
この関数は、ソケットなしでUDPメッセージを送信します。

構造体

otUdpReceiver

この構造はUDPレシーバーを表します。

otUdpSocket

この構造はUDPソケットを表します。

列挙

otNetifIdentifier

 otNetifIdentifier

この列挙は、OpenThreadネットワークインターフェイス識別子を定義します。

プロパティ
OT_NETIF_BACKBONE

バックボーンインターフェイス。

OT_NETIF_THREAD

スレッドインターフェイス。

OT_NETIF_UNSPECIFIED

不特定のネットワークインターフェース。

Typedef

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

この列挙は、OpenThreadネットワークインターフェイス識別子を定義します。

otUdpHandler

bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)

このコールバックにより、OpenThreadは特定のUDPメッセージに特定のハンドラーを提供できます。

詳細
戻り値
true
メッセージはこの受信者によって処理されるため、これ以上処理しないでください。
false
メッセージはこの受信者によって処理されません。

otUdpReceive

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

このコールバックにより、OpenThreadは受信したUDPメッセージをアプリケーションに通知できます。

otUdpReceiver

struct otUdpReceiver otUdpReceiver

この構造はUDPレシーバーを表します。

otUdpSocket

struct otUdpSocket otUdpSocket

この構造はUDPソケットを表します。

関数

otUdpAddReceiver

otError otUdpAddReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

この関数は、UDPレシーバーを追加します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aUdpReceiver
UDPレシーバーへのポインター。
戻り値
OT_ERROR_NONE
レシーバーが正常に追加されました。
OT_ERROR_ALREADY
UDPレシーバーはすでに追加されています。

otUdpBind

otError otUdpBind(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName,
  otNetifIdentifier aNetif
)

UDP / IPv6ソケットをバインドします。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
[in] aSockName
IPv6ソケットアドレス構造へのポインタ。
[in] aNetif
バインドするネットワークインターフェイス。
戻り値
OT_ERROR_NONE
バインド操作は成功しました。
OT_ERROR_FAILED
UDPソケットのバインドに失敗しました。

otUdpClose

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

UDP / IPv6ソケットを閉じます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
戻り値
OT_ERROR_NONE
ソケットを正常に閉じました。
OT_ERROR_FAILED
UDPソケットを閉じることができませんでした。

otUdpConnect

otError otUdpConnect(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName
)

UDP / IPv6ソケットを接続します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
[in] aSockName
IPv6ソケットアドレス構造へのポインタ。
戻り値
OT_ERROR_NONE
接続操作は成功しました。
OT_ERROR_FAILED
UDPソケットの接続に失敗しました。

otUdpGetSockets

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

この関数は、UDPソケットのリンクリストの先頭を取得します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
戻り値
UDPソケットリンクリストの先頭へのポインタ。

otUdpIsOpen

bool otUdpIsOpen(
  otInstance *aInstance,
  const otUdpSocket *aSocket
)

UDPソケットが開いているかどうかを確認します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
戻り値
UDPソケットが開いているかどうか。

otUdpNewMessage

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

UDPメッセージを送信するための新しいメッセージバッファを割り当てます。

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

otUdpOpen

otError otUdpOpen(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otUdpReceive aCallback,
  void *aContext
)

UDP / IPv6ソケットを開きます。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
[in] aCallback
アプリケーションコールバック関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
ソケットを正常に開きました。
OT_ERROR_FAILED
ソケットを開けませんでした。

otUdpRemoveReceiver

otError otUdpRemoveReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

この関数は、UDPレシーバーを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aUdpReceiver
UDPレシーバーへのポインター。
戻り値
OT_ERROR_NONE
受信機は正常に削除されました。
OT_ERROR_NOT_FOUND
UDPレシーバーは追加されませんでした。

otUdpSend

otError otUdpSend(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

UDP / IPv6メッセージを送信します。

戻り値がOT_ERROR_NONEであれば、OpenThreadは、所有権の取りaMessageし、呼び出し側は、もはや参照すべきaMessage 。戻り値がOT_ERROR_NONEされていない場合、呼び出し側が所有権の保持aMessage解放しないなど、 aMessageメッセージバッファが不要になった場合を。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aSocket
UDPソケット構造へのポインタ。
[in] aMessage
メッセージバッファへのポインタ。
[in] aMessageInfo
メッセージ情報構造へのポインター。

詳細
戻り値
OT_ERROR_NONE
メッセージの送信が正常にスケジュールされています。
OT_ERROR_INVALID_ARGS
無効な引数が指定されています。
OT_ERROR_NO_BUFS
UDPおよびIPv6ヘッダーを追加するための使用可能なバッファーが不十分です。

otUdpSendDatagram

otError otUdpSendDatagram(
  otInstance *aInstance,
  otMessage *aMessage,
  otMessageInfo *aMessageInfo
)

この関数は、ソケットなしでUDPメッセージを送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aMessage
UDPヘッダーのないメッセージへのポインター。
[in] aMessageInfo
関連付けられているメッセージの情報へのポインタaMessage
戻り値
OT_ERROR_NONE
メッセージを出力インターフェイスに正常にエンキューしました。
OT_ERROR_NO_BUFS
IPv6ヘッダーを追加するための使用可能なバッファーが不十分です。