Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

nl :: Dệt :: Ràng buộc

#include <src/lib/core/WeaveBinding.h>

Nắm bắt mục tiêu dự kiến ​​của giao tiếp Weave và thông tin cấu hình liên quan.

Tóm lược

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

Cấu hình

Các ứng dụng phải cấu hình một Ràng buộc với các tham số cụ thể cho loại kênh truyền thông mong muốn. Liên kết cung cấp hỗ trợ cho một loạt các phương tiện truyền tải mạng, bao gồm TCP, UDP, UDP với Nhắn tin đáng tin cậy Weave và Weave qua BLE (WoBLE). Các ứ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ệ các tin nhắn được gửi giữa các bên. Chúng bao gồm các phiên CASE và PASE, và các khóa nhóm ứng dụng. Giao diện để định cấu hình Binding sử dụng kiểu API khai báo cho phép các ứng dụng nêu các yêu cầu của chúng đối với giao tiếp bằng các thuật ngữ đơn giản.

Xem tài liệu về Ràng buộc :: Cấu hình để biết thêm chi tiết.

Sự chuẩn bị

Trước khi giao tiếp diễn ra, một Ràng buộc 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 để giao tiếp diễn ra. Điều này có thể bao gồm những thứ như: phân giải địa chỉ mạng của máy ngang hàng, thiết lập kết nối mạng và đàm phán khóa bảo mật. Sau khi được cấu hình bởi ứng dụng, Binding sẽ thực hiện tất cả các bước cần thiết để chuẩn bị cho giao tiếp, gọi lại ứng dụng khi quá trình hoàn tất. Bằng cách này, Bindings ẩn đi cơ chế giao tiếp, cho phép các ứng dụng tập trung vào các tương tác cấp cao.

Giao tiếp

Khi Ràng buộc đã được chuẩn bị, nó sẽ sẵn sàng để sử dụng. Trong trạng thái này, các ứng dụng (hoặc thông thường hơn, mã lớp giao thức làm việc thay mặt cho một ứng dụng) yêu cầu Ràng buộc phân bổ ngữ cảnh trao đổi Weave. Bối cảnh trao đổi kết quả được định cấu hình trước để giao tiếp, cho phép ứng dụng bắt đầu ngay lập tức trao đổi Weave với đồng nghiệp. Ứng dụng có thể tiếp tục yêu cầu bối cảnh trao đổi từ Ràng buộc cho đến khi Thời điểm ràng buộc bị đóng, hoặc một số sự kiện, ví dụ: lỗi mạng, chấm dứt kênh liên lạc cơ bản.

Thay đổi trạng thái ràng buộc

Trong quá trình sử dụng, Binding sẽ cung cấp các sự kiện API đến ứng dụng để thông báo về những thay đổi trong trạng thái của Binding . Ví dụ, khi việc 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 bị lỗi, một sự kiện sẽ được gửi đến ứng dụng thông báo rằng Ràng buộc không còn ở trạng thái sẵn sàng.

Các sự kiện API được chuyển đến ứng dụng thông qua một hàm gọi lại sự kiện được cung cấp khi Phân bổ ràng buộc .

Ràng buộc thời gian sống

Ràng buộc được tính tham chiếu để cho phép sử dụng chung trên nhiều thành phần phần mềm. Khi một ràng buộc được cấp phát, một tham chiếu duy nhất đến ràng buộc sẽ được tạo. Ứng dụng có trách nhiệm phát hành tham chiếu này vào một thời điểm nào đó trong tương lai để Ràng buộc được miễn phí cho việc sử dụng lại sau này.

Khi một ứng dụng được thực hiện xong với Binding, nó có thể gọi Close () trên ràng buộc. Điều này giải phóng tham chiếu của ứng dụng đến Ràng buộc và chặn tất cả việc phân phối thêm các sự kiện API. Khi tham chiếu cuối cùng đến Ràng buộc được phát hành, nó sẽ tự động bị đóng.

Các loại công khai

@23 {
kGetPeerDescription_MaxLength = nl::Weave::kWeavePeerDescription_MaxLength
}
enum
EventCallback )(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType {
kEvent_ConnectionEstablished = 1,
kEvent_BindingReady = 2,
kEvent_PrepareFailed = 3,
kEvent_BindingFailed = 4,
kEvent_PrepareRequested = 5,
kEvent_PASEParametersRequested = 6,
kEvent_TAKEParametersRequested = 7,
kEvent_DefaultCheck = 100
}
enum
State enum

Thuộc tính công cộng

AppState
void *

Chức năng công cộng

AddRef (void)
void
Dành một tham chiếu đến đối tượng ràng buộc.
AdjustResponseTimeout ( ExchangeContext *apExchangeContext) const
Định cấu hình lại Ngữ cảnh Exchange hiện có để điều chỉnh thời gian chờ phản hồi.
AllocateRightSizedBuffer (PacketBuffer *& buf, const uint32_t desiredSize, const uint32_t minSize, uint32_t & outMaxPayloadSize)
BeginConfiguration ()
Là quá trình cấu hình Ràng buộc .
CanBePrepared (void) const
bool
Close (void)
void
Đóng đối tượng ràng buộc và giải phóng một tham chiếu.
GetConnection () const
Lấy đối tượng kết nối Weave được liên kết với ràng buộc.
GetDefaultResponseTimeout () const
uint32_t
Nhận thời gian chờ phản hồi trao đổi mặc định được sử dụng khi giao tiếp với đồng nghiệp.
GetDefaultWRMPConfig (void) const
const WRMPConfig &
Nhận cấu hình WRMP mặc định được sử dụng khi giao tiếp với đồng đẳng.
GetEncryptionType (void) const
uint8_t
Truy xuất kiểu mã hóa tin nhắn sẽ được sử dụng khi mã hóa tin nhắn đến / từ ngang hàng.
GetEventCallback () const
EventCallback
Nhận hàm sẽ được gọi khi sự kiện API xảy ra cho Ràng buộc .
GetExchangeManager () const
GetKeyId (void) const
uint32_t
Truy xuất id của khóa mã hóa tin nhắn sẽ được sử dụng khi mã hóa các tin nhắn đến / đi từ đồng đẳng.
GetLogId (void) const
uint16_t
Nhận một id duy nhất cho ràng buộc.
GetMaxWeavePayloadSize (const System::PacketBuffer *msgBuf)
uint32_t
Nhận kích thước tải trọng Weave tối đa có thể vừa với PacketBuffer được cung cấp.
GetPeerDescription (char *buf, uint32_t bufSize) const
void
Xây dựng một chuỗi mô tả nút ngang hàng và địa chỉ / thông tin kết nối liên quan của nó.
GetPeerIPAddress ( nl::Inet::IPAddress & address, uint16_t & port, InterfaceId & interfaceId) const
void
Truy xuất thông tin địa chỉ IP cho ngang hàng, nếu có.
GetPeerNodeId (void) const
uint64_t
Truy xuất id nút của đồng đẳng liên kết.
GetProtocolLayerCallback (EventCallback & callback, void *& state) const
void
GetState (void) const
State
Truy xuất trạng thái hiện tại của ràng buộc.
IsAuthenticMessageFromPeer (const WeaveMessageInfo *msgInfo)
bool
Xác định xem một tin nhắn đến cụ thể có phải từ máy ngang hàng đã định cấu hình và được xác thực phù hợp hay không.
IsConnectionTransport () const
bool
IsPreparing (void) const
bool
IsReady (void) const
bool
IsUDPTransport () const
bool
IsUnreliableUDPTransport () const
bool
IsWRMTransport () const
bool
NewExchangeContext ( ExchangeContext *& appExchangeContext)
Phân bổ một Bối cảnh Exchange mới để giao tiếp với đồng đẳng là mục tiêu của ràng buộc.
Release (void)
void
Giải phóng một tham chiếu đến đối tượng ràng buộc.
RequestPrepare ()
Yêu cầu ứng dụng cấu hình và chuẩn bị Ràng buộc .
Reset (void)
void
Đặt lại ràng buộc về trạng thái chưa được định cấu hình.
SetDefaultResponseTimeout (uint32_t msec)
void
Đặt thời gian chờ phản hồi trao đổi mặc định được sử dụng khi giao tiếp với đồng nghiệp.
SetDefaultWRMPConfig (const WRMPConfig & wrmpConfig)
void
Đặt cấu hình WRMP mặc định được sử dụng khi giao tiếp với đồng đẳng.
SetEventCallback (EventCallback aEventCallback)
void
Đặt hàm do ứng dụng xác định sẽ được gọi khi sự kiện API xảy ra đối với Ràng buộc .
SetProtocolLayerCallback (EventCallback callback, void *state)
void
Đặt chức năng gọi lại sự kiện cho mã lớp giao thức bằng cách sử dụng Ràng buộc thay mặt cho một ứng dụng.

Chức năng tĩnh công khai

DefaultEventHandler (void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Trình xử lý mặc định cho các sự kiện API ràng buộc.

Các lớp học

nl :: Weave :: Binding :: Cấu hình

Cung cấp giao diện kiểu khai báo để định cấu hình và chuẩn bị đối tượng Binding .

Cấu trúc

nl :: Weave :: Binding :: InEventParam

Nhập thông số cho sự kiện API ràng buộc .

nl :: Weave :: Binding :: OutEventParam

Xuất tham số cho một sự kiện API ràng buộc .

Các loại công khai

@ 23

 @23
Tính chất
kGetPeerDescription_MaxLength

Độ dài tối đa của chuỗi (bao gồm cả ký tự NUL) được trả về bởi GetPeerDescription () .

EventCallback

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

Loại sự kiện

 EventType
Tính chất
kEvent_BindingFailed

Liên kết không thành công và không còn có thể được sử dụng để giao tiếp với đồng đẳng.

kEvent_BindingReady

Hành động chuẩn bị trên liên kết đã thành công và ràng buộc bây giờ có thể được sử dụng để giao tiếp với đồng đẳng.

kEvent_ConnectionEstablished

Kết nối Weave được yêu cầu đã được thiết lập.

kEvent_DefaultCheck

Được sử dụng để xác minh xử lý sự kiện mặc định chính xác trong ứng dụng.

kEvent_PASEParametersRequested

Ứng dụng được yêu cầu cung cấp các tham số được sử dụng trong quá trình thiết lập phiên PASE.

kEvent_PrepareFailed

Hành động chuẩn bị trên liên kết không thành công.

kEvent_PrepareRequested

Ứng dụng được yêu cầu cấu hình và chuẩn bị ràng buộc để sử dụng bởi ngăn xếp mạng.

kEvent_TAKEParametersRequested

Ứng dụng được yêu cầu cung cấp các tham số được sử dụng trong quá trình thiết lập phiên TAKE.

Tiểu bang

 State

Thuộc tính công cộng

AppState

void * AppState

Chức năng công cộng

AddRef

void AddRef(
  void
)

Dành một tham chiếu đến đối tượng ràng buộc.

AdjustResponseTimeout

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

Định cấu hình lại Ngữ cảnh Exchange hiện có để điều chỉnh thời gian chờ phản hồi.

Chi tiết
Thông số
[in] apExchangeContext
Một con trỏ đến một đối tượng Exchange Context để được cấu hình lại

AllocateRightSizedBuffer

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

BeginConfiguration

Configuration BeginConfiguration()

Là quá trình cấu hình Ràng buộc .

Các ứng dụng phải gọi BeginConfiguration () để định cấu hình Binding trước khi chuẩn bị cho nó giao tiếp với đồng đẳng.

Chi tiết
Lợi nhuận
Một đối tượng Binding :: Configuration có thể được sử dụng để định cấu hình ràng buộc.

CanBePrepared

bool CanBePrepared(
  void
) const 

Đóng

void Close(
  void
)

Đóng đối tượng ràng buộc và giải phóng một tham chiếu.

Khi được gọi, phương thức này làm cho ràng buộc chuyển sang trạng thái Đóng. Mọi hành động chuẩn bị đang thực hiện cho ràng buộc đều bị hủy bỏ và tất cả các nguồn thông tin liên lạc bên ngoài do ràng buộc nắm giữ được giải phóng.

Gọi Close () làm giảm số lượng tham chiếu liên quan đến ràng buộc, giải phóng đối tượng nếu số lượng tham chiếu trở thành 0.

GetConnection

WeaveConnection * GetConnection() const 

Lấy đối tượng kết nối Weave được liên kết với ràng buộc.

Chi tiết
Lợi nhuận
Một con trỏ tới đối tượng WeaveConnection hoặc NULL nếu không có kết nối nào được liên kết với ràng buộc.

GetDefaultResponseTimeout

uint32_t GetDefaultResponseTimeout() const 

Nhận thời gian chờ phản hồi trao đổi mặc định được sử dụng khi giao tiếp với đồng nghiệp.

Chi tiết
Lợi nhuận
Thời gian chờ phản hồi tính bằng mili giây.

GetDefaultWRMPConfig

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

Nhận cấu hình WRMP mặc định được sử dụng khi giao tiếp với đồng đẳng.

Chi tiết
Lợi nhuận
Tham chiếu đến cấu trúc WRMPConfig chứa các giá trị cấu hình mặc định.

GetEncryptionType

uint8_t GetEncryptionType(
  void
) const 

Truy xuất kiểu mã hóa tin nhắn sẽ được sử dụng khi mã hóa tin nhắn đến / từ ngang hàng.

GetEventCallback

EventCallback GetEventCallback() const 

Nhận hàm sẽ được gọi khi sự kiện API xảy ra cho Ràng buộc .

Chi tiết
Lợi nhuận
Một con trỏ đến hàm gọi lại.

GetExchangeManager

WeaveExchangeManager * GetExchangeManager() const 

GetKeyId

uint32_t GetKeyId(
  void
) const 

Truy xuất id của khóa mã hóa tin nhắn sẽ được sử dụng khi mã hóa các tin nhắn đến / từ một máy ngang hàng.

GetLogId

uint16_t GetLogId(
  void
) const 

Nhận một id duy nhất cho ràng buộc.

GetMaxWeavePayloadSize

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

Nhận kích thước tải trọng Weave tối đa có thể vừa với PacketBuffer được cung cấp.

Đối với UDP, bao gồm UDP với WRM, kích thước tải trọng tối đa được trả về sẽ đảm bảo thông báo Weave kết quả sẽ không làm tràn UDP MTU đã định cấu hình.

Ngoài ra, phương pháp này sẽ đảm bảo tải trọng Weave sẽ không làm tràn bộ đệm PacketBuffer được cung cấp.

Chi tiết
Thông số
[in] msgBuf
Một con trỏ tới PacketBuffer mà trọng tải thông báo sẽ được ghi.
Lợi nhuận
Kích thước tải trọng tối đa của Weave.

GetPeerDescription

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

Xây dựng một chuỗi mô tả nút ngang hàng và địa chỉ / thông tin kết nối liên quan của nó.

Chi tiết
Thông số
[in] buf
Một con trỏ tới bộ đệm mà chuỗi sẽ được ghi vào đó. Bộ đệm được cung cấp ít nhất phải lớn bằng kGetPeerDescription_MaxLength. Nếu một bộ đệm nhỏ hơn được cung cấp, chuỗi sẽ được cắt bớt để vừa. Đầu ra sẽ bao gồm một ký tự kết thúc NUL trong mọi trường hợp.
[in] bufSize
Kích thước của bộ đệm do buf trỏ vào.

GetPeerIPAddress

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

Truy xuất thông tin địa chỉ IP cho ngang hàng, nếu có.

Tính khả dụng của thông tin địa chỉ IP của ngang hàng phụ thuộc vào trạng thái và cấu hình của ràng buộc. Thông tin địa chỉ IP chỉ khả dụng khi sử dụng phương tiện truyền tải dựa trên IP (TCP, UDP hoặc UDP với WRMP). Trước khi bắt đầu chuẩn bị, thông tin địa chỉ chỉ có sẵn nếu nó đã được ứng dụng thiết lập rõ ràng trong quá trình cấu hình. Trong giai đoạn chuẩn bị, thông tin địa chỉ có sẵn khi quá trình chuẩn bị địa chỉ hoàn tất (ví dụ: sau khi hoàn thành phân giải DNS). Sau khi Ràng buộc sẵn sàng, thông tin địa chỉ vẫn có sẵn cho đến khi Ràng buộc được đặt lại.

Chi tiết
Thông số
[out] address
Tham chiếu đến đối tượng IPAddress sẽ nhận địa chỉ IP của đối tượng ngang hàng. Nếu thông tin địa chỉ IP của người ngang hàng không có sẵn, giá trị này sẽ được đặt thành IPAddress :: Any .
[out] port
Một tham chiếu đến một số nguyên sẽ nhận số cổng của trình ngang hàng. Nếu thông tin địa chỉ IP của người ngang hàng không khả dụng, giá trị này không được xác định.
[out] interfaceId
Tham chiếu đến một số nguyên sẽ nhận id của giao diện mạng mà qua đó đồng đẳng có thể được tiếp cận. Nếu thông tin địa chỉ IP của người ngang hàng không có sẵn, giá trị này không được xác định.

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const 

Truy xuất id nút của đồng đẳng liên kết.

Chỉ hợp lệ khi đối tượng ràng buộc đã được chuẩn bị.

Chi tiết
Lợi nhuận
Dệt ID nút của đồng đẳng

GetProtocolLayerCallback

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

GetState

State GetState(
  void
) const 

Truy xuất trạng thái hiện tại của ràng buộc.

Chi tiết
Lợi nhuận
Trạng thái ràng buộc.

IsAuthenticMessageFromPeer

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

Xác định xem một tin nhắn đến cụ thể có phải từ máy ngang hàng đã định cấu hình và được xác thực thích hợp hay không.

Phương thức này xác nhận các chi tiết sau về thông báo đã cho:

  • Thông báo bắt nguồn từ nút ngang hàng của liên kết
  • Thông báo đã được nhận qua cùng một loại truyền tải với liên kết. Nếu tin nhắn được nhận qua kết nối, phương pháp cũng xác nhận rằng tin nhắn đã được nhận qua kết nối chính xác được liên kết với ràng buộc.
  • Khóa mã hóa và loại được sử dụng để mã hóa tin nhắn khớp với những khóa và loại được định cấu hình trong liên kết. Đối với các ràng buộc được cấu hình mà không sử dụng bảo mật, phương pháp xác nhận rằng tin nhắn đến KHÔNG được mã hóa.

Phương pháp này được thiết kế để được sử dụng trong các giao thức như WDM, nơi các đồng nghiệp có thể bắt đầu trao đổi một cách tự nhiên trở lại nút cục bộ sau một trao đổi ban đầu từ nút này đến đồng đẳng. Trong những trường hợp như vậy, phương pháp này cho phép nút cục bộ xác nhận rằng thông báo không mong muốn đến đã được gửi bởi đồng đẳng liên quan. (Tất nhiên, đối với Bindings được định cấu hình mà không sử dụng mã hóa tin nhắn, khẳng định này không cung cấp giá trị nào từ góc độ bảo mật. Nó chỉ xác nhận rằng id nút người gửi và các loại truyền tải khớp nhau.)

Lưu ý rằng nếu ràng buộc không ở trạng thái Sẵn sàng, phương thức này sẽ luôn trả về false.

Chi tiết
Thông số
[in] msgInfo
Thông tin tin nhắn Weave cho tin nhắn đến.
Lợi nhuận
Đúng nếu thông báo được xác thực từ người ngang hàng.

IsConnectionTransport

bool IsConnectionTransport() const 

IsPreparing

bool IsPreparing(
  void
) const 

Chi tiết
Lợi nhuận
Đúng nếu Ràng buộc hiện đang được chuẩn bị.

Sẵn sàng

bool IsReady(
  void
) const 

Chi tiết
Lợi nhuận
Đúng nếu Ràng buộc ở trạng thái Sẵn sàng.

IsUDPTransport

bool IsUDPTransport() const 

Không đáng tin cậyUDPTransport

bool IsUnreliableUDPTransport() const 

IsWRMTransport

bool IsWRMTransport() const 

NewExchangeContext

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

Phân bổ một Ngữ cảnh Exchange mới để giao tiếp với đồng đẳng là mục tiêu của ràng buộc.

Chi tiết
Thông số
[out] appExchangeContext
Tham chiếu đến một con trỏ sẽ nhận đối tượng Exchange Context mới được cấp phát. Con trỏ sẽ được đặt thành NULL trong trường hợp phương thức không thành công.
Giá trị trả lại
WEAVE_NO_ERROR
Nếu bối cảnh trao đổi đã được phân bổ thành công.
WEAVE_ERROR_NO_MEMORY
Nếu không có sẵn bộ nhớ để cấp phát bối cảnh trao đổi.
WEAVE_ERROR_INCORRECT_STATE
Nếu ràng buộc không ở trạng thái Sẵn sàng.
other
Các lỗi khác liên quan đến cấu hình ngữ cảnh trao đổi dựa trên cấu hình của ràng buộc.

Giải phóng

void Release(
  void
)

Giải phóng một tham chiếu đến đối tượng ràng buộc.

Nếu không còn tham chiếu nào đến đối tượng ràng buộc, ràng buộc được đóng và giải phóng.

RequestPrepare

WEAVE_ERROR RequestPrepare()

Yêu cầu ứng dụng cấu hình và chuẩn bị Ràng buộc .

Mã lớp giao thức có thể sử dụng phương pháp này trên một Liên kết chưa được định cấu hình hoặc không thành công, để kích hoạt sự kiện đối với ứng dụng (kEvent_PrepareRequested) yêu cầu nó cấu hình và chuẩn bị liên kết để sử dụng.

Phương thức này chỉ có thể được gọi khi Bindings ở trạng thái NotConfigured hoặc Failed.

Nếu ứng dụng không hỗ trợ cấu hình / chuẩn bị Ràng buộc theo yêu cầu, phương pháp này sẽ không thành công với WEAVE_ERROR_NOT_IMPLEMENTED.

Cài lại

void Reset(
  void
)

Đặt lại ràng buộc về trạng thái chưa được định cấu hình.

Khi Reset () được gọi, mọi hành động chuẩn bị đang thực hiện cho liên kết sẽ bị hủy bỏ và tất cả các tài nguyên truyền thông bên ngoài do liên kết nắm giữ sẽ được giải phóng. Reset () đặt ràng buộc ở trạng thái Chưa định cấu hình, sau đó nó có thể được định cấu hình và chuẩn bị lại.

Reset () không làm thay đổi số tham chiếu của ràng buộc.

SetDefaultResponseTimeout

void SetDefaultResponseTimeout(
  uint32_t msec
)

Đặt thời gian chờ phản hồi trao đổi mặc định được sử dụng khi giao tiếp với đồng nghiệp.

Chi tiết
Thông số
[in] timeout
Thời gian chờ phản hồi mới tính bằng mili giây.

SetDefaultWRMPConfig

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

Đặt cấu hình WRMP mặc định được sử dụng khi giao tiếp với đồng đẳng.

Chi tiết
Thông số
[in] aWRMPConfig
Tham chiếu đến cấu trúc WRMPConfig chứa cấu hình mặc định mới.

SetEventCallback

void SetEventCallback(
  EventCallback aEventCallback
)

Đặt hàm do ứng dụng xác định sẽ được gọi khi sự kiện API xảy ra đối với Ràng buộc .

Chi tiết
Thông số
[in] aEventCallback
Một con trỏ đến hàm gọi lại.

SetProtocolLayerCallback

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

Đặt chức năng gọi lại sự kiện cho mã lớp giao thức bằng cách sử dụng Ràng buộc thay mặt cho một ứng dụng.

Hàm này sẽ được gọi cùng với hàm gọi lại do ứng dụng xác định khi các sự kiện API xảy ra cho Ràng buộc .

Chi tiết
Thông số
[in] callback
Một con trỏ đến hàm gọi lại.
[in] state
Một con trỏ tới một đối tượng trạng thái sẽ được cung cấp cho mã lớp giao thức khi một lệnh gọi lại lớp giao thức xảy ra.

Chức năng tĩnh công khai

DefaultEventHandler

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

Trình xử lý mặc định cho các sự kiện API ràng buộc.

Các ứng dụng bắt buộc phải gọi phương thức này cho bất kỳ sự kiện API nào mà chúng không nhận ra hoặc xử lý. Các tham số được cung cấp phải giống với các tham số được truyền bởi liên kết với hàm xử lý sự kiện của ứng dụng.

Chi tiết
Thông số
[in] apAppState
Một con trỏ tới thông tin trạng thái do ứng dụng xác định được liên kết với ràng buộc.
[in] aEvent
ID sự kiện được chuyển bởi lệnh gọi lại sự kiện
[in] aInParam
Tham chiếu các tham số sự kiện đầu vào được truyền bởi lệnh gọi lại sự kiện
[in] aOutParam
Tham chiếu các tham số sự kiện đầu ra được truyền bởi lệnh gọi lại sự kiện