Document thread-safety of APIs

Open
#956 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
documentation

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.

Description

documentation enhancement triaged

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?)

Dominant language
Java
Stars
334
Forks
319
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudfoundry/cf-java-client

All issues in cloudfoundry/cf-java-client

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.