нл:: Переплетение:: Профили:: Сетевое обеспечение:: Сервер NetworkProvisioningServer
#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>
Класс сервера для реализации профиля Network Provisioning.
Краткое содержание
Наследование
Наследуется от: nl::Weave::WeaveServerBase Прямые известные подклассы: nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl > nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<ImplClass> Защищенные атрибуты
мкуроптипе
uint8_t mCurOpType
мластопресулт
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult
Публичные атрибуты
СтатусКод
uint16_t StatusCode
Статуспрофилеид
uint32_t StatusProfileId
Общественные функции
В этом
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr
)
Инициализируйте состояние сервера Network Provisioning Server и зарегистрируйтесь для получения сообщений Network Provisioning.
Подробности | Параметры | [in] exchangeMgr | Указатель на систему Weave Exchange Manager. |
|
Возвращаемые значения | WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS | Если уже зарегистрировано слишком много обработчиков сообщений. | WEAVE_NO_ERROR | Об успехе. |
|
Сервер NetworkProvisioningServer
NetworkProvisioningServer(
void
)
Отправитьадднетворккомплете
virtual WEAVE_ERROR SendAddNetworkComplete(
uint32_t networkId
)
Отправьте сообщение «Добавление сети завершено», если сеть была успешно добавлена.
Подробности | Параметры | [in] networkId | Идентификатор добавленной сети. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_NO_MEMORY | При невозможности выделить PacketBuffer. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение «Добавить сеть завершено». |
|
ОтправитьGetNetworksComplete
virtual WEAVE_ERROR SendGetNetworksComplete(
uint8_t resultCount,
PacketBuffer *resultsTLV
)
Отправьте сообщение Get Networks Complete, содержащее ранее отсканированные сети.
Подробности | Параметры | [in] resultCount | Количество результатов сканирования. | [in] scanResultsTLV | Результаты сканирования. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_BUFFER_TOO_SMALL | Если буфер результатов недостаточно велик. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение Get Networks Complete. |
|
ОтправитьGetWirelessRegulatoryConfigComplete
virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
PacketBuffer *resultsTLV
)
Отправьте одноранговому узлу сообщение GetWirelessRegulatoryConfigComplete.
Подробности | Параметры | [in] resultsTLV | Буфер пакетов, содержащий возвращаемую информацию о нормативной конфигурации беспроводной сети. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_NO_MEMORY | При невозможности выделить PacketBuffer. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение «Добавить сеть завершено». |
|
ОтправитьНетворкСканКомплете
virtual WEAVE_ERROR SendNetworkScanComplete(
uint8_t resultCount,
PacketBuffer *scanResultsTLV
)
Отправьте ответное сообщение Network Scan Complete, содержащее результаты сканирования.
Подробности | Параметры | [in] resultCount | Количество результатов сканирования. | [in] scanResultsTLV | Результаты сканирования. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_BUFFER_TOO_SMALL | Если буфер результатов недостаточно велик. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить ответ о завершении сканирования. |
|
Отправитьстатусрепорт
virtual WEAVE_ERROR SendStatusReport(
uint32_t statusProfileId,
uint16_t statusCode,
WEAVE_ERROR sysError
)
Отправьте ответ отчета о состоянии на запрос.
Подробности | Параметры | [in] statusProfileId | Идентификатор профиля Weave, к которому относится этот отчет о состоянии. | [in] statusCode | Код состояния, который будет включен в этот ответ. | [in] sysError | Код системной ошибки, который будет включен в этот ответ. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если запрос не обрабатывается. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправлять отчет о состоянии. |
|
ОтправитьSuccessResponse
virtual WEAVE_ERROR SendSuccessResponse(
void
)
Отправьте успешный ответ на запрос на предоставление сети.
Подробности | Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если запрос не обрабатывается. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить ответ об успехе. |
|
SetDelegate
void SetDelegate(
NetworkProvisioningDelegate *delegate
)
Настройте делегата на обработку событий Network Provisioning Server.
Подробности | Параметры | [in] delegate | Указатель на делегата обеспечения сети. |
|
Неисправность
WEAVE_ERROR Shutdown(
void
)
Завершите работу сервера обеспечения сети.
Подробности | Возвращаемые значения | WEAVE_NO_ERROR | Об успехе. |
|
,
нл:: Переплетение:: Профили:: Сетевое обеспечение:: Сервер NetworkProvisioningServer
#include <src/lib/profiles/network-provisioning/NetworkProvisioning.h>
Класс сервера для реализации профиля Network Provisioning.
Краткое содержание
Наследование
Наследуется от: nl::Weave::WeaveServerBase Прямые известные подклассы: nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl< NetworkProvisioningServerImpl > nl::Weave::DeviceLayer::Internal::GenericNetworkProvisioningServerImpl<ImplClass> Защищенные атрибуты
мкуроптипе
uint8_t mCurOpType
мластопресулт
struct nl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServer::@217 mLastOpResult
Публичные атрибуты
СтатусКод
uint16_t StatusCode
Статуспрофилеид
uint32_t StatusProfileId
Общественные функции
В этом
WEAVE_ERROR Init(
WeaveExchangeManager *exchangeMgr
)
Инициализируйте состояние сервера Network Provisioning Server и зарегистрируйтесь для получения сообщений Network Provisioning.
Подробности | Параметры | [in] exchangeMgr | Указатель на систему Weave Exchange Manager. |
|
Возвращаемые значения | WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS | Если уже зарегистрировано слишком много обработчиков сообщений. | WEAVE_NO_ERROR | Об успехе. |
|
Сервер NetworkProvisioningServer
NetworkProvisioningServer(
void
)
Отправитьадднетворккомплете
virtual WEAVE_ERROR SendAddNetworkComplete(
uint32_t networkId
)
Отправьте сообщение «Добавление сети завершено», если сеть была успешно добавлена.
Подробности | Параметры | [in] networkId | Идентификатор добавленной сети. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_NO_MEMORY | При невозможности выделить PacketBuffer. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение «Добавить сеть завершено». |
|
ОтправитьGetNetworksComplete
virtual WEAVE_ERROR SendGetNetworksComplete(
uint8_t resultCount,
PacketBuffer *resultsTLV
)
Отправьте сообщение Get Networks Complete, содержащее ранее отсканированные сети.
Подробности | Параметры | [in] resultCount | Количество результатов сканирования. | [in] scanResultsTLV | Результаты сканирования. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_BUFFER_TOO_SMALL | Если буфер результатов недостаточно велик. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение Get Networks Complete. |
|
ОтправитьGetWirelessRegulatoryConfigComplete
virtual WEAVE_ERROR SendGetWirelessRegulatoryConfigComplete(
PacketBuffer *resultsTLV
)
Отправьте одноранговому узлу сообщение GetWirelessRegulatoryConfigComplete.
Подробности | Параметры | [in] resultsTLV | Буфер пакетов, содержащий возвращаемую информацию о нормативной конфигурации беспроводной сети. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_NO_MEMORY | При невозможности выделить PacketBuffer. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить сообщение «Добавить сеть завершено». |
|
ОтправитьНетворкСканКомплете
virtual WEAVE_ERROR SendNetworkScanComplete(
uint8_t resultCount,
PacketBuffer *scanResultsTLV
)
Отправьте ответное сообщение Network Scan Complete, содержащее результаты сканирования.
Подробности | Параметры | [in] resultCount | Количество результатов сканирования. | [in] scanResultsTLV | Результаты сканирования. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если сервер Network Provisioning Server инициализирован неправильно. | WEAVE_ERROR_BUFFER_TOO_SMALL | Если буфер результатов недостаточно велик. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить ответ о завершении сканирования. |
|
Отправитьстатусрепорт
virtual WEAVE_ERROR SendStatusReport(
uint32_t statusProfileId,
uint16_t statusCode,
WEAVE_ERROR sysError
)
Отправьте ответ отчета о состоянии на запрос.
Подробности | Параметры | [in] statusProfileId | Идентификатор профиля Weave, к которому относится этот отчет о состоянии. | [in] statusCode | Код состояния, который будет включен в этот ответ. | [in] sysError | Код системной ошибки, который будет включен в этот ответ. |
|
Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если запрос не обрабатывается. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправлять отчет о состоянии. |
|
ОтправитьSuccessResponse
virtual WEAVE_ERROR SendSuccessResponse(
void
)
Отправьте успешный ответ на запрос на предоставление сети.
Подробности | Возвращаемые значения | WEAVE_ERROR_INCORRECT_STATE | Если запрос не обрабатывается. | WEAVE_NO_ERROR | Об успехе. | other | Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству отправить ответ об успехе. |
|
SetDelegate
void SetDelegate(
NetworkProvisioningDelegate *delegate
)
Настройте делегата на обработку событий Network Provisioning Server.
Подробности | Параметры | [in] delegate | Указатель на делегата обеспечения сети. |
|
Неисправность
WEAVE_ERROR Shutdown(
void
)
Завершите работу сервера обеспечения сети.
Подробности | Возвращаемые значения | WEAVE_NO_ERROR | Об успехе. |
|