[SERVER-60745] Improve documentation for using `ExecutorFuture` and `TaskExecutor` Created: 15/Oct/21  Updated: 06/Dec/22

Status: Backlog
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Amirsaman Memaripour Assignee: Backlog - Service Architecture
Resolution: Unresolved Votes: 0
Labels: sa-remove-fv-backlog-22
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Service Arch
Participants:
Story Points: 2

 Description   

We should improve the documentation on how to properly manage the lifetime of a TaskExecutor when used with instances of ExecutorFuture.

In particular, we have instances of TaskExecutor that create a Client for each executor thread, requiring the executor to properly shutdown and join before the ServiceContext is destroyed. The documentation should highlight that the executor (and its threads) will stay alive so long as executor futures (and asynchronous loops) are not destroyed.


Generated at Thu Feb 08 05:50:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.