WPILibC++  2020.3.2
Notifier.h
1 /*----------------------------------------------------------------------------*/
2 /* Copyright (c) 2016-2019 FIRST. All Rights Reserved. */
3 /* Open Source Software - may be modified and shared by FRC teams. The code */
4 /* must be accompanied by the FIRST BSD license file in the root directory of */
5 /* the project. */
6 /*----------------------------------------------------------------------------*/
7 
8 #pragma once
9 
10 #include <stdint.h>
11 
12 #include "hal/Types.h"
13 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
32 HAL_NotifierHandle HAL_InitializeNotifier(int32_t* status);
33 
40 void HAL_SetNotifierName(HAL_NotifierHandle notifierHandle, const char* name,
41  int32_t* status);
42 
50 void HAL_StopNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);
51 
59 void HAL_CleanNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);
60 
69 void HAL_UpdateNotifierAlarm(HAL_NotifierHandle notifierHandle,
70  uint64_t triggerTime, int32_t* status);
71 
79 void HAL_CancelNotifierAlarm(HAL_NotifierHandle notifierHandle,
80  int32_t* status);
81 
91 uint64_t HAL_WaitForNotifierAlarm(HAL_NotifierHandle notifierHandle,
92  int32_t* status);
93 
94 #ifdef __cplusplus
95 } // extern "C"
96 #endif
97 
HAL_CancelNotifierAlarm
void HAL_CancelNotifierAlarm(HAL_NotifierHandle notifierHandle, int32_t *status)
Cancels the next notifier alarm.
HAL_SetNotifierName
void HAL_SetNotifierName(HAL_NotifierHandle notifierHandle, const char *name, int32_t *status)
Sets the name of a notifier.
HAL_WaitForNotifierAlarm
uint64_t HAL_WaitForNotifierAlarm(HAL_NotifierHandle notifierHandle, int32_t *status)
Waits for the next alarm for the specific notifier.
HAL_UpdateNotifierAlarm
void HAL_UpdateNotifierAlarm(HAL_NotifierHandle notifierHandle, uint64_t triggerTime, int32_t *status)
Updates the trigger time for a notifier.
HAL_CleanNotifier
void HAL_CleanNotifier(HAL_NotifierHandle notifierHandle, int32_t *status)
Cleans a notifier.
HAL_StopNotifier
void HAL_StopNotifier(HAL_NotifierHandle notifierHandle, int32_t *status)
Stops a notifier from running.
HAL_InitializeNotifier
HAL_NotifierHandle HAL_InitializeNotifier(int32_t *status)
Initializes a notifier.