autimer.h File Reference

#include <stdint.h>

Include dependency graph for autimer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_timer_

Macros
#define	TIMER_UPDATE_ORDER_SECOND   1
#define	TIMER_UPDATE_ORDER_MINUTE   2
#define	TIMER_UPDATE_ORDER_HOUR   3
#define	TIMER_UPDATE_ORDER_INTERVAL   4
#define	TIMER_MESSAGE_CODE   8
#define	MAX_TICK_DEFAULT   UINT32_MAX

Typedefs
typedef struct _timer_	AuTimer

Functions
void	AuTimerDataInitialise ()
void	AuTimerCreate (uint16_t thread_id, int maxTickLimit, uint8_t updateOrder)
void	AuTimerStart (uint16_t threadId)
void	AuTimerStop (uint16_t threadId)
void	AuTimerDestroy (uint16_t threadID)
void	AuTimerFire (int sec, int min, int hour)

Macro Definition Documentation

MAX_TICK_DEFAULT

#define MAX_TICK_DEFAULT   UINT32_MAX

TIMER_MESSAGE_CODE

#define TIMER_MESSAGE_CODE   8

TIMER_UPDATE_ORDER_HOUR

#define TIMER_UPDATE_ORDER_HOUR   3

TIMER_UPDATE_ORDER_INTERVAL

#define TIMER_UPDATE_ORDER_INTERVAL   4

TIMER_UPDATE_ORDER_MINUTE

#define TIMER_UPDATE_ORDER_MINUTE   2

TIMER_UPDATE_ORDER_SECOND

#define TIMER_UPDATE_ORDER_SECOND   1

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

AuTimer

typedef struct _timer_ AuTimer

Function Documentation

AuTimerCreate()

void AuTimerCreate ( uint16_t  thread_id, int  maxTickLimit, uint8_t  updateOrder  )

extern

AuTimerDataInitialise()

void AuTimerDataInitialise ( )

extern

AuTimerDestroy()

void AuTimerDestroy ( uint16_t  threadID )

extern

AuTimerFire()

void AuTimerFire ( int  sec, int  min, int  hour  )

extern

AuTimerStart()

void AuTimerStart ( uint16_t  threadId )

extern

AuTimerStop()

void AuTimerStop ( uint16_t  threadId )

extern