Пинг-отправитель

Этот файл включает API OpenThread для модуля отправителя ping.

Краткое содержание

Определения типов

otPingSenderConfig определение типа
Представляет конфигурацию запроса проверки связи.
otPingSenderReply определение типа
Представляет ответ ping.
otPingSenderReplyCallback )(const otPingSenderReply *aReply, void *aContext) определение типа
void(*
Тип указателя указывает обратный вызов для уведомления о получении ответа на запрос проверки связи.
otPingSenderStatistics определение типа
Представляет статистику запроса ping.
otPingSenderStatisticsCallback )(const otPingSenderStatistics *aStatistics, void *aContext) определение типа
void(*
Тип указателя указывает обратный вызов для отчета статистики проверки связи.

Функции

otPingSenderPing ( otInstance *aInstance, const otPingSenderConfig *aConfig)
Запускает пинг.
otPingSenderStop ( otInstance *aInstance)
void
Останавливает текущий пинг.

Структуры

отпингсендерконфиг

Представляет конфигурацию запроса проверки связи.

otPingSenderReply

Представляет ответ ping.

отпингсендерстатистика

Представляет статистику запроса ping.

Определения типов

отпингсендерконфиг

struct otPingSenderConfig otPingSenderConfig

Представляет конфигурацию запроса проверки связи.

otPingSenderReply

struct otPingSenderReply otPingSenderReply

Представляет ответ ping.

otPingSenderReplyCallback

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

Тип указателя указывает обратный вызов для уведомления о получении ответа на запрос проверки связи.

Подробности
Параметры
[in] aReply
Указатель на otPingSenderReply , содержащий информацию о полученном ответе ping.
[in] aContext
Указатель на контекст конкретного приложения.

отпингсендерстатистика

struct otPingSenderStatistics otPingSenderStatistics

Представляет статистику запроса ping.

otPingSenderStatisticsCallback

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

Тип указателя указывает обратный вызов для отчета статистики проверки связи.

Подробности
Параметры
[in] aStatistics
Указатель на otPingSenderStatistics , содержащий информацию о полученной статистике пинга.
[in] aContext
Указатель на контекст конкретного приложения.

Функции

otPingSenderPing

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

Запускает пинг.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aConfig
Используемая конфигурация ping.
Возвращаемые значения
OT_ERROR_NONE
Пинг начался успешно.
OT_ERROR_BUSY
Не удалось запустить, так как занят предыдущим текущим запросом проверки связи.
OT_ERROR_INVALID_ARGS
aConfig содержит недопустимые параметры (например, слишком длинный интервал проверки связи).

отпингсендерстоп

void otPingSenderStop(
  otInstance *aInstance
)

Останавливает текущий пинг.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .