Skip to content

Document the synchronous Complete convention - #4908

Open
bernardnormier wants to merge 1 commit into
icerpc:mainfrom
bernardnormier:document-complete-convention
Open

Document the synchronous Complete convention#4908
bernardnormier wants to merge 1 commit into
icerpc:mainfrom
bernardnormier:document-complete-convention

Conversation

@bernardnormier

Copy link
Copy Markdown
Member

Adds a dismissed-audit pattern for the decision recorded in #965: IceRPC completes pipe readers and writers with Complete, never CompleteAsync, and treats Complete as a fast, non-blocking call. The pattern also records why this works (no Complete() with unflushed bytes; decorators and transports don't wait in Complete) and how a decorator that must emit a trailer, such as the compressor's, fits in: a few synchronous bytes that fail fast on a completed decoratee, with no asynchronous finalization step.

The review of #4840 showed this decision was not captured anywhere an AI reviewer would find it.

What's Changed entry

None — documentation for AI coding agents.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@bernardnormier bernardnormier added the documentation Improvements or additions to documentation label Aug 31, 2026
@bernardnormier bernardnormier added this to the 0.6.1 milestone Aug 31, 2026
@bernardnormier
bernardnormier requested review from pepone and removed request for InsertCreativityHere August 31, 2026 14:57

@externl externl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants