Support a user-defined private state for continuous service requests

Open
#26 0 comments 0 reactions 1 assignee View on GitHub

@mxgrey is already working on this.

Since Sep 25, 2024.

Assessment

This issue has not been assessed yet.

Description

Continuous services may fulfill requests over the course of multiple schedule cycles. To implement the service, users might want to store a state data structure that persists across the cycles. Each state instance should be associated with exactly one ongoing request.

We should add a fourth generic parameter called State to ContinuousServiceKey and ContinuousQuery. It would have a default argument of (), which should preserve backwards compatibility for the API.

To begin we will require the State to implement Default so we can default-initialize the value upon a new request coming in. We could consider requiring it to implement FromWorld instead, or come up with our own trait similar to FromWorld that also provides information about the source and provider entity as well as the initial request data, all alongside a &mut World.

Dominant language
Rust
Stars
75
Forks
18
Avg merge
12d 12h
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from open-rmf/crossflow

All issues in open-rmf/crossflow

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.