nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine

#include <src/lib/profiles/data-management/Current/SubscriptionEngine.h>

Đây là một singleton lưu trữ tất cả gói thuê bao WDM Next, ở cả phía khách hàng và nhà xuất bản.

Tóm tắt

Hàm khởi tạo và phá huỷ
SubscriptionEngine(void)

Loại công khai
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
Đặt hàm quay lại sự kiện và con trỏ đến đối tượng trạng thái được liên kết cho các lệnh gọi lại cụ thể của SubscriptionEngine.
EventID enum
Các sự kiện được tạo trực tiếp từ thành phần này.

Hàm tĩnh công khai
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Đây là trình xử lý sự kiện mặc định được lớp ứng dụng gọi cho mọi sự kiện bị bỏ qua hoặc không nhận dạng được.
GetInstance(void)
Truy xuất Công cụ đăng ký singleton.

Hàm công khai
GetExchangeManager(void) const
GetMinEventLogPosition(size_t & outLogPosition) const
Truy xuất vị trí tương đối tối thiểu của điểm giảm tải sự kiện từ tất cả trình xử lý thuê bao đang hoạt động.
Init(nl::Weave::WeaveExchangeManager *const apExchangeMgr, void *const aAppState, const EventCallback aEventCallback)
SetEventCallback(void *const aAppState, const EventCallback aEventCallback)
void
Đặt hàm quay lại sự kiện và con trỏ đến đối tượng trạng thái được liên kết cho các lệnh gọi lại cụ thể của SubscriptionEngine.

Liên minh
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::InEventParam

Các thông số đến được gửi cùng với các sự kiện được tạo trực tiếp từ thành phần này.

nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine::OutEventParam

Các thông số đi được gửi cùng với sự kiện được tạo trực tiếp từ thành phần này.

Loại công khai

EventCallback

void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

Đặt hàm quay lại sự kiện và con trỏ đến đối tượng trạng thái được liên kết cho các lệnh gọi lại cụ thể của SubscriptionEngine.

Thông tin chi tiết
Thông số
[in] aAppState
Con trỏ trỏ đến đối tượng trạng thái được cung cấp của lớp ứng dụng
[in] aEvent
Con trỏ hàm để gọi lại sự kiện
[in] aInParam
Tham chiếu const đến thông số đầu vào cho sự kiện này
[out] aOutParam
Tham chiếu đến thông số đầu ra của sự kiện này

EventID

 EventID

Các sự kiện được tạo trực tiếp từ thành phần này.

Hàm tĩnh công khai

DefaultEventHandler

void DefaultEventHandler(
  EventID aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

Đây là trình xử lý sự kiện mặc định được lớp ứng dụng gọi cho mọi sự kiện bị bỏ qua hoặc không nhận dạng được.

Thông tin chi tiết
Thông số
[in] aEvent
Con trỏ hàm để gọi lại sự kiện
[in] aInParam
Tham chiếu const đến thông số đầu vào cho sự kiện này
[out] aOutParam
Tham chiếu đến thông số đầu ra của sự kiện này

GetInstance

SubscriptionEngine * GetInstance(
  void
)

Truy xuất Công cụ đăng ký singleton.

Lưu ý rằng hàm này phải được lớp chấp nhận triển khai.

Thông tin chi tiết
Trả về
Con trỏ đến Công cụ đăng ký dùng chung

Hàm công khai

GetExchangeManager

nl::Weave::WeaveExchangeManager * GetExchangeManager(
  void
) const

GetMinEventLogPosition

WEAVE_ERROR GetMinEventLogPosition(
  size_t & outLogPosition
) const

Truy xuất vị trí tương đối tối thiểu của điểm giảm tải sự kiện từ tất cả trình xử lý thuê bao đang hoạt động.

Truy xuất vị trí tương đối tối thiểu (so với thời gian khởi động) của điểm giảm tải sự kiện từ tất cả trình xử lý thuê bao đang hoạt động.

Thông tin chi tiết
Thông số
[in,out] outLogPosition
Điểm giảm tải nhật ký tối thiểu đối với tất cả trình xử lý thuê bao đang hoạt động. Nếu không có trình xử lý gói thuê bao nào đang hoạt động, thì giá trị này sẽ không thay đổi. Vị trí nhật ký được đặt thành 0 khi khởi động trình xử lý gói thuê bao.
Giá trị trả về
WEAVE_NO_ERROR
vô điều kiện

Khởi tạo

WEAVE_ERROR Init(
  nl::Weave::WeaveExchangeManager *const apExchangeMgr,
  void *const aAppState,
  const EventCallback aEventCallback
)

SetEventCallback

void SetEventCallback(
  void *const aAppState,
  const EventCallback aEventCallback
)

Đặt hàm quay lại sự kiện và con trỏ đến đối tượng trạng thái được liên kết cho các lệnh gọi lại cụ thể của SubscriptionEngine.

Thông tin chi tiết
Thông số
[in] aAppState
Con trỏ trỏ đến đối tượng trạng thái được cung cấp của lớp ứng dụng
[in] aEventCallback
Con trỏ hàm để gọi lại sự kiện

SubscriptionEngine

 SubscriptionEngine(
  void
)