cloudfoundry / cloudfoundry/cf-java-client
Document thread-safety of APIs
オープン
まだ誰も着手していません。
documentation
enhancement
triaged
- 主要言語
- Java
- スター
- 334
- フォーク
- 319
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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?)
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず DefaultConnectionContext と関連するクライアント API を確認し、どのオブジェクトをスレッド間で再利用できるか、またどのようなスレッドセーフティ保証が適用されるかを判断します。クライアント、接続コンテキスト、その他の関連 API について結論を文書化します。ユーザーが何をスレッド間で共有できるかを明確に判断できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100