nl::Weave::Binding

Фиксирует предполагаемую цель связи Weave и связанную с ней информацию о конфигурации.

Сводка

Объект Binding определяет целевой объект для обмена данными по протоколу Weave (также называемый "партнером") и набор параметров конфигурации, описывающих, как должно осуществляться взаимодействие с партнером. Привязки не зависят от протокола приложения, используемого сторонами. Таким образом, они фиксируют, кто и как общался, но не что именно было сказано.

Настройка

Приложения должны настраивать привязку с параметрами, соответствующими типу нужного канала связи. Привязки обеспечивают поддержку ряда сетевых транспортов, включая TCP, UDP, UDP с Weave Reliable Messaging и Weave over BLE (WoBLE). Приложения также могут запрашивать использование определенных механизмов безопасности для защиты сообщений, отправляемых между сторонами. К ним относятся сеансы CASE и PASE, а также ключи групп приложений. Интерфейс для настройки привязки использует декларативный стиль API, который позволяет приложениям указывать свои требования к связи простыми терминами.

Подробную информацию можно найти в документации по Binding::Configuration.

Подготовка

Перед началом обмена данными необходимо подготовить привязку. Подготовка привязки включает в себя установку необходимого состояния для обмена данными. Например, это может быть определение сетевого адреса пира, установка сетевого подключения и согласование электронных ключей. После настройки приложением привязка выполняет все необходимые шаги для подготовки к обмену данными, вызывая приложение по завершении процесса. Таким образом, привязки скрывают механику связи, позволяя приложениям сосредоточиться на взаимодействиях высокого уровня.

Связь

После подготовки привязки ее можно использовать. В этом состоянии приложения (или, чаще, код уровня протокола, работающий от имени приложения) запрашивают у Binding выделение контекста обмена Weave. Полученный контекст обмена предварительно настроен для связи, что позволяет приложению немедленно инициировать обмен Weave с одноранговым узлом. Приложение может продолжать запрашивать контексты обмена у привязки до тех пор, пока привязка не будет закрыта или какое-либо событие, например сбой сети, не приведет к закрытию базового канала связи.

Изменения состояния привязки

В процессе использования Binding будет отправлять в приложение события API, информирующие об изменениях состояния Binding. Например, когда подготовка завершится успешно, приложение получит событие, сообщающее, что привязка готова к использованию. Аналогично, если базовый канал связи не работает, приложение получает событие, сообщающее, что привязка больше не находится в состоянии готовности.

События API передаются приложению с помощью функции обратного вызова, указанной при выделении Binding.

Привязка (за все время)

Привязки учитываются по количеству ссылок, чтобы их можно было использовать в нескольких компонентах ПО. При выделении привязки создается одна ссылка на нее. Приложение должно освободить эту ссылку в будущем, чтобы Binding можно было использовать повторно.

Когда приложение завершает работу с привязкой, оно может вызвать для нее метод Close(). Это освобождает ссылку приложения на Binding и блокирует дальнейшую доставку событий API. Когда последняя ссылка на Binding освобождается, он автоматически закрывается.

Общедоступные типы

 @23

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

 EventType

 State

void * AppState

void AddRef(
  void
)

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

Configuration BeginConfiguration()

bool CanBePrepared(
  void
) const 

void Close(
  void
)

WeaveConnection * GetConnection() const 

uint32_t GetDefaultResponseTimeout() const 

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

uint8_t GetEncryptionType(
  void
) const 

EventCallback GetEventCallback() const 

WeaveExchangeManager * GetExchangeManager() const 

uint32_t GetKeyId(
  void
) const 

uint16_t GetLogId(
  void
) const 

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

uint64_t GetPeerNodeId(
  void
) const 

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

State GetState(
  void
) const 

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

bool IsConnectionTransport() const 

bool IsPreparing(
  void
) const 

bool IsReady(
  void
) const 

bool IsUDPTransport() const 

bool IsUnreliableUDPTransport() const 

bool IsWRMTransport() const 

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

void Release(
  void
)

WEAVE_ERROR RequestPrepare()

void Reset(
  void
)

void SetDefaultResponseTimeout(
  uint32_t msec
)

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

void SetEventCallback(
  EventCallback aEventCallback
)

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)