cloudfoundry / cloudfoundry/cf-java-client
Document thread-safety of APIs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 334
- Forks
- 319
- PR merge metrics
- No merged PRs in 30d
Description
We're using cf-java-client in a multi-threaded application. Are DefaultConnectionContext etc. thread-safe? This is not documented right now, and they make heavy use of threading internally (with thread pools etc.), which makes me wonder at what kind of level I can reuse objects between threads (can I reuse clients? connection contexts? none of the above?)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing DefaultConnectionContext and the related client APIs to determine which objects can be reused across threads and what thread-safety guarantees apply. Document the conclusions for clients, connection contexts, and other relevant APIs; done means users can clearly tell what may be shared between threads.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100