niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ensure that timer period is non-negative (#295)

Browse source
This commit is contained in:
Dirk Thomas 2018-09-06 18:36:28 -07:00 • committed by GitHub
parent 16adb1e4f6
commit a0f83b071a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
rcl/include/rcl/timer.h
View file

@ -81,7 +81,8 @@ rcl_get_zero_initialized_timer(void);
* The clock handle must be a pointer to an initialized rcl_clock_t struct.
* The life time of the clock must exceed the life time of the timer.
*
* The period is a duration (rather an absolute time in the future).
* The period is a non-negative duration (rather an absolute time in the
* future).
* If the period is `0` then it will always be ready.
*
* The callback is an optional argument.

4
rcl/src/rcl/timer.c
View file

@ -62,6 +62,10 @@ rcl_timer_init(
RCL_CHECK_ALLOCATOR_WITH_MSG(&allocator, "invalid allocator", return RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(timer, RCL_RET_INVALID_ARGUMENT, allocator);
RCL_CHECK_ARGUMENT_FOR_NULL(clock, RCL_RET_INVALID_ARGUMENT, allocator);
if (period < 0) {
RCL_SET_ERROR_MSG("timer period must be non-negative", allocator);
return RCL_RET_INVALID_ARGUMENT;
}
RCUTILS_LOG_DEBUG_NAMED(ROS_PACKAGE_NAME, "Initializing timer with period: %" PRIu64 "ns", period)
if (timer->impl) {
RCL_SET_ERROR_MSG("timer already initailized, or memory was uninitialized", allocator);