Class

AsyncPeriodicGRPCTask

AsyncPeriodicGRPCTask()

Constructor

# new AsyncPeriodicGRPCTask()

Periodic task to be accomplished using asynchronous GRPC calls. When it is time to run the task, an async GRPC call is run resulting in a FutureWrapper object. The FutureWrapper is monitored for completion, and then an action is taken in response.

View Source bosdyn-client/async_tasks.js, line 109

Extends

Methods

# abstract _handle_error(exception)

Override to handle any exception raised in handling GRPC result.
Parameters:
Name Type Description
exception Error Error exception to handle.
Overrides:

View Source bosdyn-client/async_tasks.js, line 156

# abstract _handle_result(result)

Override to handle result of grpc query when it is available.
Parameters:
Name Type Description
result * Result to handle.
Overrides:

View Source bosdyn-client/async_tasks.js, line 147

# _should_query(now_sec) → {boolean}

Check if it is time to query again.
Parameters:
Name Type Description
now_sec number Time now in seconds.
Overrides:

View Source bosdyn-client/async_tasks.js, line 130

True if it is time to query again based on now_sec, False otherwise.
boolean

# abstract _start_query()

Override to start async grpc query and return future-wrapper for result.
Overrides:

View Source bosdyn-client/async_tasks.js, line 138

# update() → {void}

Call this periodically to manage execution of task represented by this object
Inherited From:

View Source bosdyn-client/async_tasks.js, line 90

void

AsyncPeriodicGRPCTask(period_sec)

Constructor

# new AsyncPeriodicGRPCTask(period_sec)

Parameters:
Name Type Description
period_sec number Time to wait in seconds between queries.

View Source bosdyn-client/async_tasks.js, line 120

Methods

# abstract _handle_error(exception)

Override to handle any exception raised in handling GRPC result.
Parameters:
Name Type Description
exception Error Error exception to handle.
Overrides:

View Source bosdyn-client/async_tasks.js, line 156

# abstract _handle_result(result)

Override to handle result of grpc query when it is available.
Parameters:
Name Type Description
result * Result to handle.
Overrides:

View Source bosdyn-client/async_tasks.js, line 147

# _should_query(now_sec) → {boolean}

Check if it is time to query again.
Parameters:
Name Type Description
now_sec number Time now in seconds.
Overrides:

View Source bosdyn-client/async_tasks.js, line 130

True if it is time to query again based on now_sec, False otherwise.
boolean

# abstract _start_query()

Override to start async grpc query and return future-wrapper for result.
Overrides:

View Source bosdyn-client/async_tasks.js, line 138

# update() → {void}

Call this periodically to manage execution of task represented by this object
Inherited From:

View Source bosdyn-client/async_tasks.js, line 90

void