hal/src/main/native/include/HAL/Notifier.h

/*----------------------------------------------------------------------------*/
/* Copyright (c) 2016-2017 FIRST. All Rights Reserved.                        */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project.                                                               */
/*----------------------------------------------------------------------------*/

#pragma once

#include <stdint.h>

#include "HAL/Types.h"

#ifdef __cplusplus
extern "C" {
#endif

HAL_NotifierHandle HAL_InitializeNotifier(int32_t* status);
void HAL_StopNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);
void HAL_CleanNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);
void HAL_UpdateNotifierAlarm(HAL_NotifierHandle notifierHandle,
                             uint64_t triggerTime, int32_t* status);
void HAL_CancelNotifierAlarm(HAL_NotifierHandle notifierHandle,
                             int32_t* status);
uint64_t HAL_WaitForNotifierAlarm(HAL_NotifierHandle notifierHandle,
                                  int32_t* status);

#ifdef __cplusplus
}  // extern "C"
#endif
artf2612: Added Python script for updating license in source files (#57) This is a follow-up of 3cd1253. A C++ program was written to automate the license update originally. That program was translated to Python so it can be kept in the repository and run when needed. It has been tested on Windows using the standard Python 3 installation and on Linux. The original version skipped files that had "//" at the beginning since most were files that should be excluded. The relevant files are now in an exclusion list and the rest are processed normally. The .hpp file extension has been added as well. The script rewrote CompressorJNI.cpp to remove the carriage returns from its line endings. 2016-05-25 20:23:37 -07:00			`/----------------------------------------------------------------------------/`
Contents of copyright line now has more standard ordering (#585) 2017-08-23 22:06:13 -07:00			`/* Copyright (c) 2016-2017 FIRST. All Rights Reserved. */`
artf2612: Added Python script for updating license in source files (#57) This is a follow-up of 3cd1253. A C++ program was written to automate the license update originally. That program was translated to Python so it can be kept in the repository and run when needed. It has been tested on Windows using the standard Python 3 installation and on Linux. The original version skipped files that had "//" at the beginning since most were files that should be excluded. The relevant files are now in an exclusion list and the rest are processed normally. The .hpp file extension has been added as well. The script rewrote CompressorJNI.cpp to remove the carriage returns from its line endings. 2016-05-25 20:23:37 -07:00			`/* Open Source Software - may be modified and shared by FRC teams. The code */`
			`/* must be accompanied by the FIRST BSD license file in the root directory of */`
			`/* the project. */`
			`/----------------------------------------------------------------------------/`

Reverting back to static .a files for C++ and fixing lots of other assorted items 2014-05-02 17:54:01 -04:00			`#pragma once`

			`#include <stdint.h>`

Switches HAL to fixed length signed integers, and adds our own HAL_Bool Type (#155) * Switches HAL to fixed length signed integers, and adds our own HAL_Bool type * Replaces HAL Floats with Doubles Doubles are just as fast as floats with optimizations turned on, so switches to all doubles. All made doubles for consistency. * Prepends HAL/ to HAL include files. Also fixes some range errors 2016-07-12 10:45:14 -07:00			`#include "HAL/Types.h"`
Moves Notifier over to handles (#97) Internally, the linked list now uses shared_ptrs instead of raw pointers. In addition, in the WPILib the notifier handle is now made atomic. Then before the class is destructed, the handle is now set to 0. This should help solve one of the existing race conditions. A 0 handle is correctly handled down at the HAL level. 2016-06-05 07:29:47 -07:00
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#ifdef __cplusplus`
Add format script which invokes clang-format on the C++ source code (#41) On Windows machines, clang-format.exe must be in the PATH environment variable. 2016-05-20 17:30:37 -07:00			`extern "C" {`
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#endif`
Fixed include order (#245) See wpilibsuite/styleguide (#11). 2016-09-25 16:50:13 -07:00
Change HAL notifier to polling. (#627) This moves the thread code to the WPILib layer, fixing various potential races and significantly simplifying the HAL implementation. 2017-11-19 17:58:40 -08:00			`HAL_NotifierHandle HAL_InitializeNotifier(int32_t* status);`
			`void HAL_StopNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);`
Renamed "pin" to "channel" and variables with underscores now use mixed case (#194) 2016-08-12 13:45:28 -07:00			`void HAL_CleanNotifier(HAL_NotifierHandle notifierHandle, int32_t* status);`
			`void HAL_UpdateNotifierAlarm(HAL_NotifierHandle notifierHandle,`
Prepends all HAL functions with HAL_ (#146) 2016-07-09 00:24:26 -07:00			`uint64_t triggerTime, int32_t* status);`
Change HAL notifier to polling. (#627) This moves the thread code to the WPILib layer, fixing various potential races and significantly simplifying the HAL implementation. 2017-11-19 17:58:40 -08:00			`void HAL_CancelNotifierAlarm(HAL_NotifierHandle notifierHandle,`
			`int32_t* status);`
			`uint64_t HAL_WaitForNotifierAlarm(HAL_NotifierHandle notifierHandle,`
			`int32_t* status);`

Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#ifdef __cplusplus`
Added brace comments (#670) Enforced by wpilibsuite/styleguide#80. 2017-10-16 19:56:08 -07:00			`} // extern "C"`
Changes HAL Headers to be C compliant. (#171) 2016-07-12 21:53:06 -07:00			`#endif`