Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Design documentation #261

Open
mdickinson opened this issue Nov 27, 2020 · 1 comment
Open

Design documentation #261

mdickinson opened this issue Nov 27, 2020 · 1 comment
Labels
component: documentation Issues related to developer and user documentation

Comments

@mdickinson
Copy link
Member

Put together some developer documentation describing how the internals of Traits Futures work. It might be interesting to try following the C4 model for this.

In particular, we want to describe the three message-passing layers / protocols:

Layer 0: Pinger/Pingee (doesn't know anything about passing actual messages or routing messges to their intended destination)
Layer 1: Message routing (doesn't know anything particularly about futures, cancellation, etc.)
Layer 2: Future-specific messaging

The description in PR #231 goes into Layer 0 in some detail, and may serve as a starting point.
@mdickinson mdickinson mentioned this issue Nov 27, 2020
Merged
@mdickinson mdickinson added this to the Release 0.3.0 milestone Nov 27, 2020
@mdickinson mdickinson added the component: documentation Issues related to developer and user documentation label Mar 27, 2021
@mdickinson
Copy link
Member Author

Not for this release.

@mdickinson mdickinson removed this from the Release 0.3.0 milestone Jul 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: documentation Issues related to developer and user documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mdickinson