nl::Weave::Binding

Chụp mục tiêu dự định của giao tiếp Weave và thông tin cấu hình liên quan.

Tóm tắt

Đối tượng Binding xác định mục tiêu dự kiến của giao tiếp Weave (còn gọi là "ngang hàng"), cùng với một tập hợp các tham số cấu hình mô tả cách giao tiếp với ứng dụng ngang hàng. Các liên kết độc lập với giao thức ứng dụng được nói giữa hai bên. Như vậy, chúng nắm bắt "ai" và "cách thức" giao tiếp, chứ không ghi "cái gì".

Cấu hình

Các ứng dụng phải định cấu hình Binding với các tham số dành riêng cho loại kênh liên lạc mong muốn. Các liên kết hỗ trợ nhiều phương thức truyền tải mạng, bao gồm cả TCP, UDP, UDP với tính năng Weave trust Messaging và Weave over BLE (WoBLE). Ứng dụng cũng có thể yêu cầu sử dụng các cơ chế bảo mật cụ thể để bảo vệ thư được gửi giữa các bên. Các khoá này bao gồm các phiên CASE và PASE cũng như các khoá nhóm ứng dụng. Giao diện để định cấu hình Liên kết sử dụng kiểu API khai báo cho phép các ứng dụng đưa ra yêu cầu giao tiếp bằng các điều khoản đơn giản.

Xem tài liệu về Binding::Configuration để biết thêm thông tin chi tiết.

Chuẩn bị

Trước khi giao tiếp diễn ra, Binding phải được "chuẩn bị". Hành động chuẩn bị Ràng buộc liên quan đến việc thiết lập trạng thái cần thiết để hoạt động giao tiếp diễn ra. Việc này có thể bao gồm những việc như: phân giải địa chỉ mạng của ứng dụng ngang hàng, thiết lập kết nối mạng và thương lượng khoá bảo mật. Sau khi được ứng dụng định cấu hình, Binding sẽ thực hiện tất cả các bước cần thiết để chuẩn bị giao tiếp, gọi lại ứng dụng khi quá trình hoàn tất. Bằng cách này, Liên kết ẩn cơ chế giao tiếp, cho phép các ứng dụng tập trung vào các hoạt động tương tác cấp cao.

Liên lạc

Sau khi chuẩn bị Liên kết, bạn sẽ có thể sử dụng nó. Ở trạng thái này, các ứng dụng (hoặc phổ biến hơn là mã lớp giao thức hoạt động thay cho một ứng dụng) yêu cầu Binding (Liên kết) để phân bổ ngữ cảnh Weave Exchange. Ngữ cảnh trao đổi kết quả được định cấu hình sẵn cho hoạt động giao tiếp, cho phép ứng dụng ngay lập tức bắt đầu trao đổi Weave với ứng dụng ngang hàng. Ứng dụng có thể tiếp tục yêu cầu ngữ cảnh trao đổi từ Liên kết cho đến khi Liên kết được đóng hoặc một số sự kiện như lỗi mạng sẽ chấm dứt kênh liên lạc cơ bản.

Các thay đổi về trạng thái liên kết

Trong quá trình sử dụng, Binding sẽ gửi các sự kiện API đến ứng dụng để thông báo cho ứng dụng về những thay đổi trong trạng thái của Binding. Ví dụ: khi chuẩn bị thành công, ứng dụng sẽ nhận được một sự kiện thông báo rằng Binding đã sẵn sàng để sử dụng. Tương tự, nếu kênh liên lạc cơ bản không thành công, thì một sự kiện sẽ được gửi đến ứng dụng thông báo cho ứng dụng rằng Binding không còn ở trạng thái sẵn sàng.

Các sự kiện API được phân phối đến ứng dụng thông qua hàm callback sự kiện được cung cấp khi Binding được phân bổ.

Thời gian tồn tại liên kết

Liên kết là các tệp đối chiếu được tính để cho phép sử dụng chung giữa nhiều thành phần phần mềm. Khi một Liên kết được phân bổ, một tham chiếu đến liên kết đó sẽ được tạo. Ứng dụng chịu trách nhiệm phát hành tệp đối chiếu này tại một thời điểm nào đó trong tương lai để Liên kết được tự do sử dụng lại sau này.

Khi một ứng dụng hoàn tất với một Binding, ứng dụng có thể gọi Close() trên liên kết. Thao tác này sẽ giải phóng tệp tham chiếu của ứng dụng đến Liên kết và chặn tất cả các sự kiện API được phân phối thêm. Khi tham chiếu cuối cùng đến một Liên kết được giải phóng, tệp này sẽ tự động bị đóng.

Loại công khai

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