連線偵測 (ping) 傳送者

這個檔案包含連線偵測 (ping) 傳送者模組的 OpenThread API。

摘要

Typedefs
otPingSenderConfig typedef
代表連線偵測要求設定。
otPingSenderReply typedef
代表連線偵測 (ping) 回覆。
otPingSenderReplyCallback)(const otPingSenderReply *aReply, void *aContext) typedef
void(*
指標類型會指定在收到連線偵測 (ping) 回覆時通知的回呼。
otPingSenderStatistics typedef
代表連線偵測要求的統計資料。
otPingSenderStatisticsCallback)(const otPingSenderStatistics *aStatistics, void *aContext) typedef
void(*
指標類型會指定回報連線偵測 (ping) 統計資料的回呼。

函式
otPingSenderPing(otInstance *aInstance, const otPingSenderConfig *aConfig)
啟動連線偵測 (ping)。
otPingSenderStop(otInstance *aInstance)
void
停止進行中的連線偵測 (ping)。

結構
otPingSenderConfig

代表連線偵測要求設定。
otPingSenderReply

代表連線偵測 (ping) 回覆。
otPingSenderStatistics

代表連線偵測要求的統計資料。

Typedefs

otPingSenderConfig

struct otPingSenderConfig otPingSenderConfig

代表連線偵測要求設定。

otPingSenderReply

struct otPingSenderReply otPingSenderReply

代表連線偵測 (ping) 回覆。

otPingSenderReplyCallback

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

指標類型會指定在收到連線偵測 (ping) 回覆時通知的回呼。

詳細說明
參數
[in] aReply
指向包含接收連線偵測 (ping) 回覆相關資訊的 otPingSenderReply 指標。
[in] aContext
指向應用程式特定背景資訊的指標。

otPingSenderStatistics

struct otPingSenderStatistics otPingSenderStatistics

代表連線偵測要求的統計資料。

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 取得。如要瞭解詳情或對說明文件做出貢獻，請參閱資源。