AliOS Things提供基本的软件定时器功能,包括定时器的创建、删除、运行,以及单次和周期定时器。

概述

tick一般是作为任务延迟调度的内部机制,其接口主要是系统内部使用。对于使用os的应用软件,也需要定时触发相关功能的接口,包括单次定时器和周期定时器。

从用户层面来讲,不关注底层cpu的定时机制以及tick的调度,用户希望的定时器接口是,可以创建和使能一个软件接口定时器,时间到了之后,用户的钩子函数能被执行。而对于操作系统的定时器本身来讲,其也需要屏蔽底层定时模块的差异。因此,在软件层次上,对于定时器硬件相关的操作由tick模块完成,定时器(timer)模块基于tick作为最基本的时间调度单元,即最小时间周期,来推动自己时间轴的运行。

API 列表

API名称 说明
aos_timer_new() 动态创建软件定时器
aos_timer_new_ext() 动态创建软件定时器
aos_timer_start() 软件定时器启动
aos_timer_stop() 软件定时器停止
aos_timer_change() 改变软件定时器的周期
aos_timer_free() 删除软件定时器

aos_timer_new()

定义描述
定义 描述
函数原型 int aos_timer_new(aos_timer_t *timer, void (*fn)(void *, void *), void *arg, int ms, int repeat)
描述 创建一个定时器,并自动运行
入参
  • timer:timer描述结构体指针,需要用户定义一个timer结构体
  • fn: 定时器处理函数
  • arg:定时器处理参数
  • ms:定时器超时时间(单位ms),即间隔多少时间执行fn
  • Repeat:周期或单次(1表示周期,0表示单次)
返回值 类型:int,返回成功或失败, 返回0表示timer创建成功,非0表示失败

aos_timer_new_ext()

定义描述
定义 描述
函数原型 int aos_timer_new_ext(aos_timer_t *timer, void (*fn)(void *, void *), void *arg, int ms, int repeat, unsigned char auto_run)
描述 创建一个定时器,根据auto_run参数选择是否自动运行
入参
  • timer:timer描述结构体指针;需要用户定义一个timer结构体
  • arg:定时器处理参数
  • fn: 定时器处理函数
  • ms:定时器超时时间(单位ms),即间隔多少时间执行fn
  • Repeat:周期或单次(1:周期,0:单次)
  • auto_run:1表示自动运行,0表示不自动运行,需要手动调用aos_timer_start才能启动
返回值 类型:int,返回成功或失败, 返回0表示timer创建成功,非0表示失败

aos_timer_start()

定义描述
定义 描述
函数原型 int aos_timer_start(aos_timer_t *timer)
描述 启动一个定时器
入参 timer:timer描述结构体指针
返回值 类型:int,返回成功或失败,返回0表示timer启动成功,非0表示失败

aos_timer_stop()

定义描述
定义 描述
函数原型 int aos_timer_stop(aos_timer_t *timer)
描述 停止一个定时器
入参 timer:timer描述结构体指针
返回值 类型:int,返回成功或失败,返回0表示timer停止成功,非0表示失败

aos_timer_change()

定义描述
定义 描述
函数原型 int aos_timer_change(aos_timer_t *timer, int ms)
描述 修改一个定时器周期
入参
  • timer:timer描述结构体指针
  • ms:新的定时器周期,单位ms
返回值 类型:int,返回成功或失败,返回0表示timer修改成功,非0表示失败

aos_timer_free()

定义描述
定义 描述
函数原型 void aos_timer_free(aos_timer_t *timer)
描述 释放一个定时器
入参 timer:timer描述结构体指针
返回值

调用示例

  • 创建自动运行的周期执行定时器。
    aos_timer_t  g_timer;
    int ret = -1;
    ...
    
    static void timer_handler(void *arg1, void* arg2)
    {
        printf("timer handler\r\n");
        ...
    }
    
    /*创建定时周期为200ms的周期执行的定时器,并自动运行*/
    ret = aos_timer_new(&g_timer, timer_handler, NULL, 200, 1);
    if (ret != 0) {
        printf("timer create failed\r\n");
           ...
       }
    
    ....
    /*停止定时器*/
    aos_timer_stop(&g_timer);
    
    ....
    
    /*启动定时器*/
    aos_timer_start(&g_timer);
    
    ....
    
    /*释放定时器*/
    aos_timer_free(&g_timer);
    ....
  • 创建不自动运行的周期执行定时器,并在使用中改变定时周期。
    aos_timer_t  g_timer;
    int ret = -1;
    ...
    
    static void timer_handler(void *arg1, void* arg2)
    {
        printf("timer handler\r\n");
        ...
    }
    
    /*创建定时周期为200ms的周期执行的定时器,不自动运行*/
    ret = aos_timer_new_ext(&g_timer, timer_handler, NULL, 200, 0, 0);
    if (ret != 0) {
        printf("timer create failed\r\n");
           ...
       }
    
    ....
    
    /*需要手动启动定时器*/
    aos_timer_start(&g_timer);
    
    ....
    
    /*停止定时器*/
    aos_timer_stop(&g_timer);
    
    ....
    
    /*改变定时周期为1000ms, 注意:需要在定时器未启动状态是才能修改*/
    aos_timer_change(&g_timer, 1000);
    
    /*启动定时器*/
    aos_timer_start(&g_timer);
    
    ....
    
    /*停止定时器*/
    aos_timer_stop(&g_timer);
    
    /*释放定时器*/
    aos_timer_free(&g_timer);
    ....