Method ReadTimestampedTimerFrequencyAsync
- Namespace
- Harp.TimestampGeneratorGen3
- Assembly
- Harp.TimestampGeneratorGen3.dll
ReadTimestampedTimerFrequencyAsync(CancellationToken)
Asynchronously reads the timestamped payload of the TimerFrequency register.
public Task<Timestamped<TimerRate>> ReadTimestampedTimerFrequencyAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenThe token to monitor for cancellation requests. The default value is None.
Returns
- Task<Timestamped<TimerRate>>
A task that represents the asynchronous read operation. The value of its Result property contains the timestamped register payload.
Exceptions
- HarpException
The device replied to the read request with an error. This exception is stored into the returned task.
- OperationCanceledException
The cancellation token was canceled. This exception is stored into the returned task.