Zen API
 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 
21 //typedef kObject kPeriodic; --forward-declared in kApiDef.x.h
22 
24 typedef kStatus (kCall *kPeriodicElapsedFx)(kPointer context, kPeriodic timer);
25 
26 #include <kApi/Threads/kPeriodic.x.h>
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 
106 kFx(k64u) kPeriodic_Period(kPeriodic timer);
107 
108 #endif
kStatus(kCall * kPeriodicElapsedFx)(kPointer context, kPeriodic timer)
Defines the signature of a callback function to receive timer notifications.
Definition: kPeriodic.h:24
Represents a 64-bit unsigned integer.
Represents a void pointer.
Represents an unsigned integer that can store a pointer address.
Abstract base class for memory allocator types.
k64u kPeriodic_Period(kPeriodic timer)
Reports the timer callback period.
Represents a single unit (byte) in a UTF-8 character.
typedef kStatus(kCall *kMsgQueueDropFx)(kPointer receiver
Defines the signature of a callback function to handle dropped items.
kBool kPeriodic_Enabled(kPeriodic timer)
Reports whether periodic timer callbacks are currently enabled.
kStatus kPeriodic_Stop(kPeriodic timer)
Stops timer callbacks.
Core Zen type declarations.
Represents a 32-bit signed integer.
kStatus kPeriodic_Construct(kPeriodic *timer, kAlloc allocator)
Constructs a kPeriodic object.
kStatus kPeriodic_ConstructEx(kPeriodic *timer, kSize stackSize, const kChar *name, k32s priority, kAlloc allocator)
Constructs a kPeriodic object with additional options.
Represents an error code.
kStatus kPeriodic_Start(kPeriodic timer, k64u period, kPeriodicElapsedFx onElapsed, kPointer context)
Starts callbacks at the specified period.
#define kCall
kApi standard function calling convention.
Definition: kApiDef.h:15
Represents a boolean value.
Provides a periodic function call.