Ping 送信者

このファイルには、ping 送信モジュール用の OpenThread API が含まれています。

概要

Typedef
otPingSenderConfig typedef
ping リクエストの構成を表します。
otPingSenderReply typedef
ping 応答を表します。
otPingSenderReplyCallback)(const otPingSenderReply *aReply, void *aContext) typedef
void(*
ポインタの種類は、ping 応答の受信を通知するコールバックを指定します。
otPingSenderStatistics typedef
ping リクエストの統計情報を表します。
otPingSenderStatisticsCallback)(const otPingSenderStatistics *aStatistics, void *aContext) typedef
void(*
ポインタの種類は、ping の統計情報を報告するコールバックを指定します。

関数
otPingSenderPing(otInstance *aInstance, const otPingSenderConfig *aConfig)
ping を開始します。
otPingSenderStop(otInstance *aInstance)
void
進行中の ping を停止します。

構造体
otPingSenderConfig

ping リクエストの構成を表します。
otPingSenderReply

ping 応答を表します。
otPingSenderStatistics

ping リクエストの統計情報を表します。

Typedef

otPingSenderConfig

struct otPingSenderConfig otPingSenderConfig

ping リクエストの構成を表します。

otPingSenderReply

struct otPingSenderReply otPingSenderReply

ping 応答を表します。

otPingSenderReplyCallback

void(* otPingSenderReplyCallback)(const otPingSenderReply *aReply, void *aContext)

ポインタの種類は、ping 応答の受信を通知するコールバックを指定します。

詳細
パラメータ
[in] aReply
受信した ping 応答に関する情報を含む otPingSenderReply へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otPingSenderStatistics

struct otPingSenderStatistics otPingSenderStatistics

ping リクエストの統計情報を表します。

otPingSenderStatisticsCallback

void(* otPingSenderStatisticsCallback)(const otPingSenderStatistics *aStatistics, void *aContext)

ポインタの種類は、ping の統計情報を報告するコールバックを指定します。

詳細
パラメータ
[in] aStatistics
受信した ping 統計情報に関する情報を含む otPingSenderStatistics へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

関数

otPingSenderPing

otError otPingSenderPing(
  otInstance *aInstance,
  const otPingSenderConfig *aConfig
)

ping を開始します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aConfig
使用する ping 構成。
戻り値
OT_ERROR_NONE
ping が正常に開始されました。
OT_ERROR_BUSY
前回の進行中の ping リクエストがビジー状態であるため開始できませんでした。
OT_ERROR_INVALID_ARGS
aConfig に無効なパラメータが含まれています（ping 間隔が長すぎるなど）。

otPingSenderStop

void otPingSenderStop(
  otInstance *aInstance
)

進行中の ping を停止します。

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

関連情報

OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。