expose rcl timers cancel, reset, is_canceled and is_ready functions. #136
Conversation
hoffmann-stefan
force-pushed
the
feature/expose_timer_functions
branch
from
d51c034 to
8523d4c
Compare
rcldotnet/Timer.cs
Outdated
| RCLExceptionHelper.CheckReturnValue(ret, $"{nameof(TimerDelegates.native_rcl_timer_reset)}() failed."); | ||
| } | ||
|
|
||
| public bool IsCanceled() |
There was a problem hiding this comment.
Given that ActionServerGoalHandle already defines some similar properties, we should make IsCanceled and IsReady get-only properties.
Normally getters should not throw exception according to the "Framework Design Guidlines".
But the only exception that could rise from this (once IDisposable is implemented) could be the ObjectDisposedException, which is allowed according to https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1065#property-get-methods
Did rebase and push the commit already.
|
For some background: This is used in our internal codebase to cancel the timers while doing our shutdown logic. (see #135 (comment) why this doesn't happen automatically with |
Exposed useful methods when working with timers.