нл:: Переплетение:: Связывание

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

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

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

Конфигурация

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

Дополнительную информацию см. в документации по Binding::Configuration .

Подготовка

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

Коммуникация

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

Привязка изменений состояния

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

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

Срок действия привязки

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

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

Публичные типы

 @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
)