nl :: Dệt :: Hệ thống :: Hẹn giờ

#include <src/system/SystemTimer.h>

Đây là một lớp học nội bộ để hệ thống Weave lớp , được sử dụng để đại diện cho một one-shot timer kinh doanh dở dang.

Tóm lược

Không có giao diện công cộng thực sự có sẵn cho lớp ứng dụng. Các phương thức công khai tĩnh được sử dụng để lấy thời gian hệ thống hiện tại được thiết kế để sử dụng nội bộ.

Di sản

Kế thừa từ: nl :: Weave :: System :: Object

Các loại công khai
`Epoch`	typedef `uint64_t` Đại diện cho một kỷ nguyên trong lịch thời gian hệ thống cục bộ, thường là lịch thời gian POSIX.
`OnCompleteFunct )(Layer aLayer, void aAppState, Error aError)`	typedef `void(*`

Thuộc tính công cộng
`OnComplete`	`OnCompleteFunct`

Chức năng tĩnh công khai
`GetCurrentEpoch (void)`	`Epoch` Phương thức này trả về kỷ nguyên hiện tại, được hiệu chỉnh bởi chế độ ngủ của hệ thống với tỷ lệ thời gian của hệ thống, tính bằng mili giây.
`GetStatistics (nl::Weave::System::Stats::count_t & aNumInUse, nl::Weave::System::Stats::count_t & aHighWatermark)`	`void`
`IsEarlierEpoch (const Epoch & first, const Epoch & second)`	`bool` So sánh hai giá trị Timer :: Epoch và trả về true nếu giá trị đầu tiên sớm hơn giá trị thứ hai.

Chức năng công cộng
`Cancel (void)`	`Error` Phương thức này khử khởi tạo đối tượng bộ hẹn giờ và ngăn bộ hẹn giờ này kích hoạt nếu nó không làm như vậy.
`Start (uint32_t aDelayMilliseconds, OnCompleteFunct aOnComplete, void *aAppState)`	`Error` Phương pháp này đăng ký bộ hẹn giờ một lần với cơ chế bộ đếm thời gian bên dưới được cung cấp bởi nền tảng.

Các loại công khai

Epoch

uint64_t Epoch

Đại diện cho một kỷ nguyên trong lịch thời gian hệ thống cục bộ, thường là lịch thời gian POSIX.

Các đơn vị phụ thuộc vào ngữ cảnh. Nếu được sử dụng với các giá trị được trả về bởi GetCurrentEpoch, đơn vị là mili giây.

OnCompleteFunct

void(* OnCompleteFunct)(Layer *aLayer, void *aAppState, Error aError)

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

OnComplete

OnCompleteFunct OnComplete

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

GetCurrentEpoch

Epoch GetCurrentEpoch(
  void
)

Phương thức này trả về kỷ nguyên hiện tại, được hiệu chỉnh bằng chế độ ngủ của hệ thống với thang thời gian của hệ thống, tính bằng mili giây.

KHÔNG DÙNG ĐƯỢC Vui lòng sử dụng System :: Layer :: GetClock_MonotonicMS () để thay thế.

Chi tiết
Lợi nhuận	Dấu thời gian tính bằng mili giây.

GetSt Statistics

void GetStatistics(
  nl::Weave::System::Stats::count_t & aNumInUse,
  nl::Weave::System::Stats::count_t & aHighWatermark
)

IsEarlierEpoch

bool IsEarlierEpoch(
  const Epoch & first,
  const Epoch & second
)

So sánh hai giá trị Timer :: Epoch và trả về true nếu giá trị đầu tiên sớm hơn giá trị thứ hai.

Một API tĩnh được gọi để so sánh 2 giá trị thời gian. API này cố gắng giải thích gói hẹn giờ bằng cách giả định rằng sự khác biệt giữa 2 giá trị đầu vào sẽ chỉ lớn hơn một nửa phạm vi vô hướng của Epoch nếu một gói hẹn giờ đã xảy ra giữa 2 mẫu.

Chi tiết
Lợi nhuận	true nếu param đầu tiên sớm hơn param thứ hai, false nếu ngược lại.

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

Huỷ bỏ

Error Cancel(
  void
)

Phương thức này khử khởi tạo đối tượng bộ hẹn giờ và ngăn bộ hẹn giờ này kích hoạt nếu nó không làm như vậy.

Chi tiết

Giá trị trả lại

WEAVE_SYSTEM_NO_ERROR

Một cách vô điều kiện.

Khởi đầu

Error Start(
  uint32_t aDelayMilliseconds,
  OnCompleteFunct aOnComplete,
  void *aAppState
)

Phương pháp này đăng ký bộ hẹn giờ một lần với cơ chế bộ đếm thời gian bên dưới được cung cấp bởi nền tảng.

Chi tiết

Thông số

`[in] aDelayMilliseconds`	Số mili giây trước khi bộ hẹn giờ này kích hoạt
`[in] aOnComplete`	Một con trỏ đến chức năng gọi lại khi bộ hẹn giờ này kích hoạt
`[in] aAppState`	Một con trỏ tùy ý được chuyển vào onComplete khi bộ hẹn giờ này kích hoạt

Giá trị trả lại

WEAVE_SYSTEM_NO_ERROR

Một cách vô điều kiện.