нл:: Переплетение:: Профили:: Сетевое обеспечение:: Делегат NetworkProvisioningDelegate

Это абстрактный класс.

#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>

Класс делегата для реализации операций подготовки сети.

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

Наследование

Наследуется от: nl::Weave::WeaveServerDelegateBase
Прямые известные подклассы:
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl >
  nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<ImplClass>

Публичные атрибуты

Server
[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект сервера, к которому прикреплен этот делегат.

Общественные функции

EnforceAccessControl ( ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Обеспечьте контроль доступа на уровне сообщений для входящего сообщения с запросом на предоставление сети.
HandleAddNetwork (PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Добавьте конкретную сеть.
HandleDisableNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
Отключить указанную сеть.
HandleEnableNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
Включите указанную сеть.
HandleGetNetworks (uint8_t flags)=0
virtual WEAVE_ERROR
Получите настроенные сети.
HandleGetWirelessRegulatoryConfig (void)
virtual WEAVE_ERROR
Получите информацию о нормативной конфигурации беспроводной сети.
HandleRemoveNetwork (uint32_t networkId)=0
virtual WEAVE_ERROR
Удалить настроенную сеть.
HandleScanNetworks (uint8_t networkType)=0
virtual WEAVE_ERROR
Выполните сканирование сети.
HandleSetRendezvousMode (uint16_t rendezvousMode)=0
virtual WEAVE_ERROR
Установите режим встречи.
HandleSetWirelessRegulatoryConfig ( PacketBuffer *regConfigTLV)
virtual WEAVE_ERROR
Установите нормативную информацию о конфигурации беспроводной сети.
HandleTestConnectivity (uint32_t networkId)=0
virtual WEAVE_ERROR
Проверьте подключение указанной сети.
HandleUpdateNetwork (PacketBuffer *networkInfoTLV)=0
virtual WEAVE_ERROR
Обновите конфигурацию сети.
IsPairedToAccount () const
virtual bool
Вызывается, чтобы определить, подключено ли устройство к учетной записи в данный момент.

Публичные атрибуты

Сервер

NetworkProvisioningServer * Server

[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект сервера, к которому прикреплен этот делегат.

Общественные функции

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Обеспечьте контроль доступа на уровне сообщений для входящего сообщения с запросом на предоставление сети.

Подробности
Параметры
[in] ec
ExchangeContext , через который было получено сообщение.
[in] msgProfileId
Идентификатор профиля полученного сообщения.
[in] msgType
Тип полученного сообщения.
[in] msgInfo
Структура WeaveMessageInfo , содержащая информацию о полученном сообщении.
[in,out] result
Перечисляемое значение, описывающее результат оценки политики управления доступом для полученного сообщения. При входе в метод значение представляет собой предварительный результат на текущем этапе процесса оценки. Ожидается, что по возвращении результат будет представлять окончательную оценку политики управления доступом для сообщения.

РучкаДобавитьСеть

virtual WEAVE_ERROR HandleAddNetwork(
  PacketBuffer *networkInfoTLV
)=0

Добавьте конкретную сеть.

Подробности
Параметры
[in] networkInfoTLV
Конфигурация сети, закодированная в TLV .
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству добавить сеть.
Смотрите также:
NetworkProvisioningDataElementTags для допустимых типов.

РучкаОтключитьСеть

virtual WEAVE_ERROR HandleDisableNetwork(
  uint32_t networkId
)=0

Отключить указанную сеть.

Подробности
Параметры
[in] networkId
Идентификатор сети, которую необходимо отключить.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отключить сеть.

РучкаEnableNetwork

virtual WEAVE_ERROR HandleEnableNetwork(
  uint32_t networkId
)=0

Включите указанную сеть.

Подробности
Параметры
[in] networkId
Идентификатор сети, которую необходимо включить.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству включить сеть.

HandleGetNetworks

virtual WEAVE_ERROR HandleGetNetworks(
  uint8_t flags
)=0

Получите настроенные сети.

Подробности
Параметры
[in] flags
Флаги для фильтрации полученных сетей.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству получить настроенные сети.

HandleGetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleGetWirelessRegulatoryConfig(
  void
)

Получите информацию о нормативной конфигурации беспроводной сети.

Подробности
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству получить запрошенную информацию.

РучкаУдалитьСеть

virtual WEAVE_ERROR HandleRemoveNetwork(
  uint32_t networkId
)=0

Удалить настроенную сеть.

Подробности
Параметры
[in] networkId
Идентификатор сети, которую необходимо удалить.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отключить сеть.

HandleScanNetworks

virtual WEAVE_ERROR HandleScanNetworks(
  uint8_t networkType
)=0

Выполните сканирование сети.

Подробности
Параметры
[in] networkType
Технология (например, Wi-Fi или Thread) для сканирования.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству выполнить сканирование сети.
Смотрите также:
NetworkType для допустимых типов.

РучкаSetRendezvousMode

virtual WEAVE_ERROR HandleSetRendezvousMode(
  uint16_t rendezvousMode
)=0

Установите режим встречи.

Подробности
Параметры
[in] rendezvousMode
Используемый режим встречи.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству установить режим встречи.
Смотрите также:
RendezvousModeFlags для допустимых режимов.

HandleSetWirelessRegulatoryConfig

virtual WEAVE_ERROR HandleSetWirelessRegulatoryConfig(
  PacketBuffer *regConfigTLV
)

Установите нормативную информацию о конфигурации беспроводной сети.

Подробности
Параметры
[in] regConfigTLV
Буфер пакетов, содержащий новую информацию о нормативной конфигурации беспроводной сети, закодированную в формате TLV .
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству установить запрошенную информацию.

HandleTestConnectivity

virtual WEAVE_ERROR HandleTestConnectivity(
  uint32_t networkId
)=0

Проверьте подключение указанной сети.

Подробности
Параметры
[in] networkId
Идентификатор сети, подключение к которой необходимо проверить.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству проверить подключение.

РучкаUpdateNetwork

virtual WEAVE_ERROR HandleUpdateNetwork(
  PacketBuffer *networkInfoTLV
)=0

Обновите конфигурацию сети.

Подробности
Параметры
[in] networkInfoTLV
Конфигурация сети, закодированная в TLV .
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству обновить сеть.
Смотрите также:
NetworkProvisioningDataElementTags для допустимых типов.

Испайредтоаккаунт

virtual bool IsPairedToAccount() const

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