Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPeriodic.h
Go to the documentation of this file.
1
10 #ifndef K_API_PERIODIC_H
11 #define K_API_PERIODIC_H
12
13 #include <kApi/kApiDef.h>
14
15 kBeginHeader()
16
17
23 //typedef kObject kPeriodic; --forward-declared in kApiDef.x.h
24
25
26 typedef kStatus (kCall *kPeriodicElapsedFx)(kPointer context, kPeriodic timer);
27
36 kFx(kStatus) kPeriodic_Construct(kPeriodic* timer, kAlloc allocator);
37
49 kFx(kStatus) kPeriodic_ConstructEx(kPeriodic* timer, kSize stackSize, const kChar* name, k32s priority, kAlloc allocator);
50
67 kFx(kStatus) kPeriodic_Start(kPeriodic timer, k64u period, kPeriodicElapsedFx onElapsed, kPointer context);
68
80 kFx(kStatus) kPeriodic_Stop(kPeriodic timer);
81
92 kFx(kBool) kPeriodic_Enabled(kPeriodic timer);
93
94 kEndHeader()
95
96 #include <kApi/Threads/kPeriodic.x.h>
97
98 #endif
kPeriodicElapsedFx
kStatus(kCall * kPeriodicElapsedFx)(kPointer context, kPeriodic timer)
Defines the signature of a callback function to receive timer notifications.
Definition: kPeriodic.h:26
k64u
Represents a 64-bit unsigned integer.
kPointer
Represents a void pointer.
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kChar
Represents a single unit (byte) in a UTF-8 character.
kPeriodic::kPeriodic_Enabled
kBool kPeriodic_Enabled(kPeriodic timer)
Reports whether periodic timer callbacks are currently enabled.
kPeriodic::kPeriodic_Stop
kStatus kPeriodic_Stop(kPeriodic timer)
Stops timer callbacks.
kApiDef.h
Core Zen type declarations.
k32s
Represents a 32-bit signed integer.
kPeriodic::kPeriodic_Construct
kStatus kPeriodic_Construct(kPeriodic *timer, kAlloc allocator)
Constructs a kPeriodic object.
kPeriodic::kPeriodic_ConstructEx
kStatus kPeriodic_ConstructEx(kPeriodic *timer, kSize stackSize, const kChar *name, k32s priority, kAlloc allocator)
Constructs a kPeriodic object with additional options.
kStatus
Represents an error code.
kPeriodic::kPeriodic_Start
kStatus kPeriodic_Start(kPeriodic timer, k64u period, kPeriodicElapsedFx onElapsed, kPointer context)
Starts callbacks at the specified period.
kCall
#define kCall
kApi standard function calling convention.
Definition: kApiDef.h:17
kBool
Represents a boolean value.
kPeriodic
Provides a periodic function call.