API Reference

Class: RateTimerServer

ROS2.0 JavaScript client with Node.js

class

RateTimerServer(parentNode)

Internal class that creates Timer instances in a common private rcl context for use with Rate. The private rcl context ensures that Rate timers do not deadlock waiting for spinOnce/spin on the main rcl context.

Constructor

class

new RateTimerServer(parentNode)

Create a new instance.
Parameters:
Name Type Description
parentNode Node The parent node for which this server supplies timers to.
Source:

Methods

function

createTimer(period) → {Timer}

Create a new timer instance with callback set to NOP.
Parameters:
Name Type Description
period number The period in milliseconds
Source:
Returns:
- The new timer instance.
Type Timer
function

(async) init() → {undefined}

Setup the server's rcl context and node in preparation for creating rate timer instances.
Source:
Returns:
Type undefined
function

shutdown() → {undefined}

Permanently cancel all timers produced by this server and discontinue the ability to create new Timers. The private rcl context is shutdown in the process and may not be restarted.
Source:
Returns:
Type undefined