A bunch of READMEs #287
Merged
A bunch of READMEs #287
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
pringshia
approved these changes
Oct 27, 2020
mephisto/server/channels/README.md
Outdated
|
|
||
| ## Retriability + Failure handling | ||
|
|
||
| Ultimately if the `Channel` that Mephisto is communicating using dies, the Mephisto process needs to suspend the current run, shutdown, and clean up. As such, we leave it up to the `Channel` implementation to determine if the connection is still stable enough to be running. `is_alive`, the retriability of `send`, and `on_catastraphic_disconnect` covers the full freedom for a `Channel` to be able to signal to Mephisto that a task is no longer salvageable. |
There was a problem hiding this comment.
small nit: spelling is catastrophic with an o
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly the title. I've added documentation to a number of areas that were lacking, but that were also unlikely to get absolutely obliterated and reshifted around in #285. Will get to the rest of the design/architecture documentation once the migration occurs.