_ketimer.h File Reference

#include <_xeneva.h>

Include dependency graph for _ketimer.h:

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

Go to the source code of this file.

Macros
#define	_KE_TIMER_UNDIFINED_MAXCOUNT   -1
#define	_KE_TIMER_UPDATE_ORDER_SECOND   1
#define	_KE_TIMER_UPDATE_ORDER_MINUTE   2
#define	_KE_TIMER_UPDATE_ORDER_HOUR   3
#define	_KE_TIMER_UPDATE_ORDER_INTERVAL   4
#define	TIMER_MESSAGE_CODE   8

Functions
XE_LIB int	_KeCreateTimer (int threadID, int maxLimit, uint8_t updateMode)
	_KeCreateTimer – create timer service
XE_LIB int	_KeStartTimer (int threadID)
	_KeStartTimer – starts the timer
XE_LIB int	_KeStopTimer (int threadID)
	_KeStopTimer– stop the timer
XE_LIB int	_KeDestroyTimer (int threadID)
	_KeDestroyTimer – remove the timer
XE_LIB int	_KeSetAlarm (unsigned long long seconds)
	_KeSetAlarm – set one-shot alarm
XE_LIB int	_KeSetITimer (int which, const void *, const void *)
XE_LIB int	_KeGetITimer (int which, const void *)

Detailed Description

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.

Macro Definition Documentation

_KE_TIMER_UNDIFINED_MAXCOUNT

#define _KE_TIMER_UNDIFINED_MAXCOUNT   -1

_KE_TIMER_UPDATE_ORDER_HOUR

#define _KE_TIMER_UPDATE_ORDER_HOUR   3

_KE_TIMER_UPDATE_ORDER_INTERVAL

#define _KE_TIMER_UPDATE_ORDER_INTERVAL   4

_KE_TIMER_UPDATE_ORDER_MINUTE

#define _KE_TIMER_UPDATE_ORDER_MINUTE   2

_KE_TIMER_UPDATE_ORDER_SECOND

#define _KE_TIMER_UPDATE_ORDER_SECOND   1

TIMER_MESSAGE_CODE

#define TIMER_MESSAGE_CODE   8

Function Documentation

_KeCreateTimer()

XE_LIB int _KeCreateTimer	(	int	threadID,
		int	maxLimit,
		uint8_t	updateMode
	)

_KeCreateTimer – create timer service

Parameters

threadID	– current thread id
maxTickLimit	– maximum tick limit
updatemode	– Timer update mode

_KeDestroyTimer()

XE_LIB int _KeDestroyTimer

(

int

threadID

)

_KeDestroyTimer – remove the timer

Parameters

threadID

– current thread id

_KeGetITimer()

XE_LIB int _KeGetITimer	(	int	which,
		const void *
	)

_KeSetAlarm()

XE_LIB int _KeSetAlarm

(

unsigned long long

seconds

)

_KeSetAlarm – set one-shot alarm

Parameters

seconds

– second to consider

_KeSetITimer()

XE_LIB int _KeSetITimer	(	int	which,
		const void *	,
		const void *
	)

_KeStartTimer()

XE_LIB int _KeStartTimer

(

int

threadID

)

_KeStartTimer – starts the timer

_KeStopTimer()

XE_LIB int _KeStopTimer

(

int

threadID

)

_KeStopTimer– stop the timer