Skip to content

docs(rcl): README/docs/サンプルを Rcl.Context/Node API に追従#106

Merged
OJII3 merged 2 commits into
mainfrom
docs/rcl-readme-and-samples
Jul 2, 2026
Merged

docs(rcl): README/docs/サンプルを Rcl.Context/Node API に追従#106
OJII3 merged 2 commits into
mainfrom
docs/rcl-readme-and-samples

Conversation

@OJII3

@OJII3 OJII3 commented Jul 2, 2026

Copy link
Copy Markdown
Owner

概要

Rcl.Context / Rcl.Node 分離 (refs #105) 後のドキュメント・サンプルが旧 DomainParticipant API のままだったため、ユーザー向け導線を新 API に揃える。

変更内容

  • README.md / README.ja.md: Quick start と QoS サンプルを Rcl.Context + Rcl.Node ベースに更新、Features に 2 層 API を追記、Legacy DomainParticipant への注記を追加
  • samples/TalkerListener / samples/SpdpDemo: DomainParticipant を Rcl.Context + Rcl.Node に置換
  • docs/interop.md: AddTwoInts サービスクライアント例を Rcl API に更新
  • docs/compatibility.md: DomainParticipantOptions 表記を ContextOptions に統一、Legacy DomainParticipant 節を追加
  • src/rosettadds/Transport/LocalNetwork.cs: を ContextOptions にも向ける
  • tests/rosettadds.Tests/Integration/* (8 ファイル): 旧 DomainParticipant API の使用は互換性検証として残し、ヘッダーコメントで意図を明示 (#pragma warning disable CS0618)

検証

  • dotnet build src/rosettadds 0 warning 0 error
  • dotnet build tests/rosettadds.Tests 0 warning 0 error
  • dotnet build samples/TalkerListener / samples/SpdpDemo 0 warning 0 error
  • dotnet test tests/rosettadds.Tests 620/621 passed
    • 唯一の失敗 (UdpTransportTests.Unicast_loopback / SedpLoopbackTests.Publisher_endpoint_reliability_QoS) は単体再実行でいずれもパスする既知の flaky で、本変更とは無関係

非対象

  • 既存 60+ テストの Rcl API への大規模移行 (別 PR)
  • DomainParticipant の public プロパティ (Guid/GuidPrefix/DiscoveryDb/...) の [Obsolete] 化 (別 PR)
  • DomainParticipant 削除 (将来 PR)

opencode added 2 commits July 2, 2026 15:25
- README.md / README.ja.md: Quick start と QoS サンプルを Rcl.Context + Rcl.Node ベースに更新し、Features に 2 層 API を追記
- samples/TalkerListener / samples/SpdpDemo: DomainParticipant を Rcl.Context + Rcl.Node に置換
- docs/interop.md: AddTwoInts サンプルを Rcl API に更新
- docs/compatibility.md: DomainParticipantOptions 表記を ContextOptions に統一、Legacy DomainParticipant 節を追加
- src/rosettadds/Transport/LocalNetwork.cs: <see cref> を ContextOptions にも向ける
- tests/rosettadds.Tests/Integration/*: 旧 API 使用は互換性検証として残し、意図をヘッダーコメントで明示 (#pragma warning disable CS0618)
@OJII3 OJII3 merged commit d28214c into main Jul 2, 2026
1 check failed
@OJII3 OJII3 deleted the docs/rcl-readme-and-samples branch July 2, 2026 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant