Skip to content

Documentation lacks information on thread safety #2351

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.

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

Closed
xCASx opened this issue Mar 29, 2021 · 4 comments
Closed

Documentation lacks information on thread safety #2351

xCASx opened this issue Mar 29, 2021 · 4 comments
Labels
documentation This is a problem with documentation.

Comments

@xCASx
Copy link

xCASx commented Mar 29, 2021

SDK v1 had a similar issue which was resolved, e.g. AmazonS3Client had a @ThreadSafe annotation.

In SDK v2 the clients aren't marked with this annotation. I also wasn't able to find any information about thread safety in the documentation.

Would be nice to have this information easily accessible.

@xCASx xCASx added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Mar 29, 2021
@debora-ito
Copy link
Member

Hi @xCASx thank you for reaching out. Yes, using @ThreadSafe would make the documentation more clear, we'll add the annotation to the client classes.

To answer your question, all SDK clients are thread safe.

@debora-ito debora-ito removed the needs-triage This issue or PR still needs to be triaged. label Mar 30, 2021
@xCASx
Copy link
Author

xCASx commented Mar 30, 2021

Thank you @debora-ito

@debora-ito
Copy link
Member

@xCASx the documentation now shows @ThreadSafe in the service clients, added via #2443.

@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants