15 Star 13 Fork 158

OpenHarmony / time_time_service

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

时间时区部件

简介

在整个OpenHarmony架构中提供管理系统时间时区和定时的能力,支持设置定时器和获取时间、时区和日期。

图 1 子系统架构图

目录

/base/time/time_service
├── etc                      # 组件包含的进程的配置文件
├── figures                  # 构架图
├── framework/js/napi        # js接口解析成napi接口
├── interfaces/inner_api     # 组件对外提供的接口代码
├── services                 # 时间服务实现
│   └── sa_profile           # 组件包含的系统服务的配置文件和进程的配置文件
├── test                     # 接口的单元测试
└── utils                    # 组件包含日志打印和有序公共事件定义的常量

说明

js接口说明

说明:

表 1 js组件systemDateTime开放的主要方法

接口名 描述
setTime(time : number) : Promise 设置系统时间(1970-01-01至今毫秒数),Promise方式。
setTime(time : number, callback : AsyncCallback) : void 设置系统时间(1970-01-01至今毫秒数),callback方式。
getCurrentTime(isNano?: boolean): Promise 获取自Unix纪元以来经过的时间,Promise方式。
getCurrentTime(isNano: boolean, callback: AsyncCallback): void 获取自Unix纪元以来经过的时间,callback方式。
getCurrentTime(callback: AsyncCallback): void 获取自Unix纪元以来经过的时间,callback方式。
getRealActiveTime(isNano?: boolean): Promise 获取自系统启动以来经过的时间,不包括深度睡眠时间,Promise方式。
getRealActiveTime(isNano: boolean, callback: AsyncCallback): void 获取自系统启动以来经过的时间,不包括深度睡眠时间,callback方式。
getRealActiveTime(callback: AsyncCallback): void 获取自系统启动以来经过的时间,不包括深度睡眠时间,callback方式。
getRealTime(isNano?: boolean): Promise 获取自系统启动以来经过的时间,包括深度睡眠时间,Promise方式。
getRealTime(isNano: boolean, callback: AsyncCallback): void 获取自系统启动以来经过的时间,包括深度睡眠时间,callback方式。
getRealTime(callback: AsyncCallback): void 获取自系统启动以来经过的时间,包括深度睡眠时间,callback方式。
setDate(date: Date, callback: AsyncCallback): void; 设置系统时间(Date格式),Promise方式。
setDate(date: Date): Promise 设置系统时间(Date格式),callback方式。
getDate(callback: AsyncCallback): void 获取当前系统日期,Promise方式。
getDate(): Promise 获取当前系统日期,callback方式。
setTimezone(timezone: string, callback: AsyncCallback): void 设置系统时区,callback方式。
setTimezone(timezone: string): Promise 设置系统时区,Promise方式。
getTimezone(callback: AsyncCallback): void 获取系统时区,callback方式。
getTimezone(): Promise 获取系统时区,Promise方式。

表 2 js组件systemTimer开放的主要方法

接口名 描述
createTimer(options: TimerOptions, callback: AsyncCallback): void 创建定时器,callback方式。
createTimer(options: TimerOptions): Promise 创建定时器,promise方式。
startTimer(timer: number, triggerTime: number, callback: AsyncCallback): void 开启定时器,callback方式。
startTimer(timer: number, triggerTime: number): Promise 开启定时器,promise方式。
stopTimer(timer: number, callback: AsyncCallback): void 停止定时器,callback方式。
stopTimer(timer: number): Promise 停止定时器,promise方式。
destroyTimer(timer: number, callback: AsyncCallback): void 销毁定时器,callback方式。
destroyTimer(timer: number): Promise 摧毁定时器,promise方式。

表 3 systemTimer组件参数TimerOptions说明

名称 类型 说明
type number 定时器类型。
取值为1时,表示为系统启动时间定时器(定时器启动时间不能晚于当前设置的系统时间);
取值为2时,表示为唤醒定时器;
取值为4时,表示为精准定时器;
取值为5时,表示为IDLE模式定时器(暂不支持)。
repeat boolean true 为循环定时器,false为单次定时器。
interval number 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。
wantAgent wantAgent 设置通知的wantagent,定时器到期后通知。
callback => void 设置回调函数,定时器到期后触发。

js接口使用说明

systemDateTime模块使用示例:

// 导入模块
import systemDateTime from '@ohos.systemDateTime';

// Promise方式的异步方法设置时间   
// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
try {
  systemDateTime.setTime(time).then(() => {
    console.info(`Succeeded in setting time.`);
  }).catch((error) => {
    console.info(`Failed to set time. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`);
}

// callback方式的异步方法设置时间
// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
try {
  systemDateTime.setTime(time, (error) => {
    if (error) {
      console.info(`Failed to set time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in setting time`);
  });
} catch(e) {
  console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`);
}

systemTimer模块使用示例:

// 导入模块
import systemTimer from '@ohos.systemTimer';

console.log("start");
var options:TimerOptions{   
   type:TIMER_TYPE_REALTIME,   
   repeat:false,   
   interval:Number.MAX_VALUE/2,   
}

console.log("create timer")   
let timerId = systemTimer.Timer(options)     
console.log("start timer")   
let startTimerRes = systemTimer.startTimer(timerId, 100000)   
console.log("stop timer")   
let stopTimerRes = systemTimer.stopTimer(timerId)   
console.log("destroy timer")   
let destroyTimerRes = systemTimer.destroyTimer(timerId)   
console.log('end');   

相关仓

时间时区子系统

time_time_service

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS

简介

Timing and time module | 时间和定时组件 展开 收起
C++ 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/openharmony/time_time_service.git
git@gitee.com:openharmony/time_time_service.git
openharmony
time_time_service
time_time_service
master

搜索帮助

14c37bed 8189591 565d56ea 8189591