HDDS-6217. Cleanup XceiverClientGrpc TODOs, and document how the client works and should be used. #3012
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.
What changes were proposed in this pull request?
As part of HDDS-5954, we have investigated the gRPC client and how it works, to see how we should tune its behaviour for erasure coded storage. At the end of the day, we decided to do not change the gRPC client and how it works in general, but we would like to document what we have found, and considered.
This PR contains our learnt knowledge, it removes the TODO comments from the XceiverClientGrpc class, and extends the APIDoc related to this class as well as adds a broader readme content about how the client works with the rest of the code.
Code changes to fix some IDE warnings along with documentation changes are:
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-6217
How was this patch tested?
Not applicable, there weren't any semantical changes made to the code.