Files
alkcall/docs/architecture
glm-5.2 495e04ed43 fix: Unit 2 — channel 0 single-stream call mode (C-01, C-25 #1)
Channel 0 was dead in both directions (C-01): the call protocol's
stream-per-request model (open_bi per call) is incompatible with
channel 0's single yield-once BiStream — every call_open_op failed
with StreamClosed on the connect side, and channel 0's Connection was
a black hole on the accept side.

The fix is single-stream call mode (ADR-036 amendment): all
EventEnvelope frames are multiplexed on channel 0's one BiStream.

Changes:
- CallConnection gains single_stream_writer: Option<Arc<SharedFrameWriter>>
  and new_single_stream() constructor. call_with_payload,
  subscribe_with_payload, publish_with_payload, and abort branch on
  is_single_stream() — in single-stream mode they write frames through
  the shared writer (mutex-serialized) instead of opening a fresh
  open_bi per call.
- Dispatcher::run_loop_single_stream reads frames off channel 0's read
  half, dispatches call.requested, writes responses through the shared
  writer, and routes in-flight call.published/call.completed/
  call.aborted to the matching Pub sink's chunk_tx by request_id.
- ChannelsAdapter::handle's InstallChannelZero hook now receives
  channel 0's Connection (built by the adapter) and runs the
  single-stream dispatch loop on it — closing the accept-side black
  hole. Mux runner is spawned BEFORE install_channel_zero so
  mux.register(0) can complete.
- ChannelClient::from_connection uses CallConnection::new_single_stream
  and spawns a read pump (read_single_stream_until_closed) that routes
  channel-0 response frames into the PendingRequestMap via
  dispatch_envelope — closing the connect-side StreamClosed path.
- ADR-036 amendment records the single-stream-mode decision (two-way
  door: implementation detail, wire format unchanged).

Acceptance gate (C-25 #1): three end-to-end tests wire
ChannelClient ↔ ChannelsAdapter over a real tokio::io::duplex pair
carrying the channels 8-byte chunk header wire format:
- channel_0_end_to_end_call_round_trip: a Query op round-trip
- channel_0_end_to_end_unknown_op_returns_not_found: NOT_FOUND
- channel_0_end_to_end_publish_delivers_chunks: a Pub op with 3 chunks

Verification: 437 tests pass (was 434; +3 e2e), clippy clean, fmt
clean, doc warnings unchanged (4, pre-existing C-09).
2026-08-12 21:55:04 +00:00
..

status, last_updated
status last_updated
draft 2026-08-12

alkcall

The call + channels RPC crate. Structured JSON RPC (operations, streaming subscriptions, service discovery) and N-channel multiplexing over one transport stream (channel 0 pre-negotiated as alknet/call).

This crate unifies alknet-call and alknet-channels from the alknet mono-repo, plus the vendored core types formerly in alknet-core. The source architecture docs were ported from /workspace/@alkdev/alknet/docs/architecture/ and renumbered as alkcall ADRs (ADR-001..045). The ALPN strings (alknet/call, alknet/channels) are wire-stable and unchanged — see ADR-004.

Documents

Document Status Description
call-README.md draft Call protocol index — adapter, stream model, registry, client (ported from alknet call/README.md)
call-protocol.md draft CallAdapter, hand-rolled EventEnvelope framing (ADR-014), stream model, PendingRequestMap, bidirectional calls
operation-registry.md draft OperationSpec, Handler, OperationRegistry, AccessControl, service discovery
client-and-adapters.md draft CallClient (transport-agnostic spawn_dispatch), from_call, OperationAdapter trait, no-env-vars invariant
channels-README.md draft Channels protocol index — wire format, adapter, lifecycle, client (ported from alknet channels/README.md)
channels-overview.md draft The multiplexing collapse, crate dependencies, transport agnosticism, WASM
channels-wire.md draft The 8-byte chunk format, sentinels, wire-level invariants (REQ-CH-01..05)
channels-connection.md draft ChannelBidiStreamSource, accept_bi yields one BiStream per channel
channels-adapter.md draft ChannelsAdapter, ChannelManager, demux/mux contracts
channel-operations.md draft channel/open, channel/close, channel/control, channel/resources/subscribe
channel-client.md draft ChannelClient — transport-agnostic from_connection primary

Applicable ADRs

Core (vendored types) — ADR-001..012

ADR Title Relevance
001 ALPN-Based Protocol Dispatch HandlerRegistry, ALPN routing
002 ProtocolHandler Trait The trait every handler implements
003 Auth as Shared Core IdentityProvider, Identity, AuthToken
004 ALPN String Convention alknet/ prefix, one ALPN per connection
005 BiStream Type Definition BiStream, handlers receive Connection
006 AuthContext Structure AuthContext fields, hybrid resolution
007 Connection::from_stream Generic single-stream connections
008 BidiStreamSource Trait Connection extension point
009 BiStream as the Handler Leaf accept_bi returns BiStream (concrete)
010 Secret Material Flow No secrets on wire; Capabilities
011 Dynamic Resource Ownership OwnershipProvider, resource_id_path
012 ConnectionCredentials Transport-level credentials, auth_token is per-request

Call protocol — ADR-013..030

ADR Title Relevance
013 irpc as Call Protocol Foundation Superseded by ADR-014
014 Hand-Rolled EventEnvelope Framing The call wire format ADR; supersedes ADR-013
015 Call Protocol Stream Model Bidi streams, EventEnvelope, ID correlation
016 Operation Error Schemas call.error with typed details
017 Privilege Model internal = authority switch; Visibility
018 Handler Registration Registration bundle, provenance, composition authority
019 Operation Registry Layering Curated + session + connection overlays; OperationEnv trait
020 Abort Cascade call.aborted cascades; abort-dependents default
021 Streaming Handler StreamingHandler, invoke_streaming()
022 Client and Adapter Contract CallClient, from_call, OperationAdapter
023 Peer-Scoped Registry Filtering Superseded by ADR-024
024 Peer-Graph Routing Model PeerCompositeEnv, PeerRef, AccessControl peer auth
025 PeerEntry and Identity.id Decoupling PeerId = Identity.id (stable)
026 Forwarded-For Identity Metadata only, never used by ACL
027 from_jsonschema as HTTP Adapter FromJsonSchema provenance stays; impl in alknet-http
028 from_call Is a Manual Free Function Assembly layer calls it after dial
029 Aggregated Peer-Environment Wiring Dispatcher hub wiring
030 PeerCompositeEnv::peer_operations OperationEnv::peer_operations override

Shared — ADR-031..033

ADR Title Relevance
031 Crate Decomposition alkcall unifies core+call+channels
032 One-Way Door Decision Framework Reversal cost classification
033 Rust as Canonical Implementation Language Rust canonical, TS reference

Channels — ADR-034..045

ADR Title Relevance
034 Channels Wire Format 8-byte chunk header; one-way door
035 Pure Channel Multiplexing No stream_type; BiStream-only; handler owns sub-mux
036 Channel 0 Pre-Negotiated Channel 0 = alknet/call
037 Channel Lifecycle Operations channel/open, close, control, resources/subscribe
038 ChannelConnection Per-channel BidiStreamSource; yield-once accept_bi
039 ChannelsAdapter and ChannelManager Demux/mux; ALPN-blind, auth-blind
040 Backpressure, Limits, ID Reuse Bounded-buffer; 256-channel memory bound
041 Per-Identity Channel Cap ChannelLifecyclePolicy; 256 per PeerId
042 Hub Relay Translate channel 0, byte-forward data channels
043 ChannelClient Transport-agnostic from_connection
044 Channels Sub-Crate Decomposition channels-core / channels-call (modules in alkcall)
045 AlknetClient Dial Seam spawn_dispatch / from_connection take-over; dial in consumer
046 Publish Operation Type and HandlerKind::Sink OperationType::Pub (client→server streaming); SinkHandler + HandlerKind::Sink; call.published wire event; invoke_sink() dispatch; Subscription renamed to Sub
047 Openable ALPNs Are Operations channel/open dissolves into per-ALPN ops channels/<alpn>/sub/pub; channel_open marker on OperationSpec; ChannelCore wrapper; extension-trait ChannelOperationEnv; connection-owner allocates channel_id; opener ledger (Gap 2 fix); ALPNs are call apps

Relevant Open Questions

See open-questions.md for the full tracker. Key questions affecting this crate:

  • OQ-01: Call protocol pub/sub primitive (partially resolved) — ADR-046 adds the Pub primitive (client→server streaming). The fan-out/broker is deferred to channels (Gap B in ADR-047 is named out-of-scope for alkcall; the hub composes the broker on top).
  • OQ-02: Full channel-level flow-control windowing (deferred(scope)) — bounded-buffer is decided (ADR-040); full windowing blocked on a real HOL-blocking deployment observation.
  • OQ-03: Channels add/strip API shape (open) — whether the 8-byte header add/strip is built into the read/write path or a standalone utility.

Key Design Principles

  1. One connection, full access: An alknet/call connection gives access to the entire operation registry.
  2. Protocol is symmetric: Both sides can initiate calls. Producer/ consumer, not server/client.
  3. Hand-rolled framing (no irpc): EventEnvelope is hand-rolled length-prefixed JSON. See ADR-014.
  4. Operation registry is layered: Curated (static) + session + connection overlays. OperationEnv is a trait. See ADR-019.
  5. No secret material on the wire: Capabilities injected at assembly layer. See ADR-010.
  6. Abort cascades to descendants: Default abort-dependents. See ADR-020.
  7. Peer authorization via AccessControl: No remote_safe flag. See ADR-024.
  8. Streams are streams: Every channel is a BiStream. The handler owns its sub-stream multiplexing. See ADR-035.
  9. Channel 0 is alknet/call: Channel lifecycle is call operations on channel 0. See ADR-036, ADR-037.
  10. Wire formats are stable: EventEnvelope shape and the 8-byte chunk header are one-way doors. See ADR-014, ADR-034.

References

  • @alkdev/alknet: docs/architecture/ — the source architecture docs these were ported from (renumbered from alknet ADR-001..094 to alkcall ADR-001..045)
  • @alkdev/alktype — the binary struct engine, used for channels chunk header layout and JSON payload schema validation
  • @alkdev/pubsub — the TypeScript EventEnvelope prior art the call wire format was derived from

Note

: The source ADRs and spec docs were ported from the parent @alkdev/alknet workspace where this crate originated. They are preserved here as the authoritative spec for alkcall; the alknet mono-repo will consume alkcall's versions when it is reworked.

Cross-references to non-ported ADRs: Some spec docs and ADRs reference alknet ADRs by their original numbers (e.g., ADR-052 for TTY's wire format, ADR-082 for alknet-tls, ADR-086 for endpoint types). These are ADRs for sibling crates that are not part of alkcall. They retain their alknet numbering (052, 082, 086, etc.) — any ADR number outside the alkcall range 001..045 is an alknet source ADR, found at /workspace/@alkdev/alknet/docs/architecture/decisions/.