From 5cac68f95c5790ff75222149a8b1fc508cf1221c Mon Sep 17 00:00:00 2001 From: "glm-5.1" Date: Mon, 8 Jun 2026 05:35:43 +0000 Subject: [PATCH] docs(interface): document SshSession recv/send stubs as planned future work Add doc comments and TODO markers to SshSession::recv() and send() explicitly marking them as Phase 1 stubs. Notes that call protocol event bridging from SSH channels is planned for Phase 2/3. --- crates/alknet-core/src/interface/ssh.rs | 8 ++++++++ tasks/cleanup/ssh-session-recv-stub-doc.md | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/crates/alknet-core/src/interface/ssh.rs b/crates/alknet-core/src/interface/ssh.rs index e46f6a7..4974c2f 100644 --- a/crates/alknet-core/src/interface/ssh.rs +++ b/crates/alknet-core/src/interface/ssh.rs @@ -586,10 +586,18 @@ impl SshSession { #[async_trait] impl InterfaceSession for SshSession { + /// Stub for Phase 1 — always returns `None`. + /// + /// TODO: Bridge `alknet-control:0` channel events to call protocol + /// `InterfaceEvent` frames. Planned for Phase 2/3. async fn recv(&mut self) -> Option { None } + /// Stub for Phase 1 — accepts silently and discards. + /// + /// TODO: Bridge outgoing `EventEnvelope` frames to the SSH channel + /// established by the call protocol. Planned for Phase 2/3. async fn send(&mut self, _envelope: EventEnvelope) -> Result<()> { Ok(()) } diff --git a/tasks/cleanup/ssh-session-recv-stub-doc.md b/tasks/cleanup/ssh-session-recv-stub-doc.md index 2746ad0..97f03f1 100644 --- a/tasks/cleanup/ssh-session-recv-stub-doc.md +++ b/tasks/cleanup/ssh-session-recv-stub-doc.md @@ -1,7 +1,7 @@ --- id: cleanup/ssh-session-recv-stub-doc name: Document SshSession::recv() stub as planned future work -status: pending +status: completed depends_on: - review/phase1-core-modifications scope: single @@ -38,4 +38,4 @@ This is acceptable for Phase 1 (tunnel functionality still works via the existin ## Summary -> To be filled on completion \ No newline at end of file +> Added doc comments to SshSession::recv() and send() marking them as Phase 1 stubs, with TODO markers noting that alknet-control:0 channel event bridging to call protocol InterfaceEvent frames is planned for Phase 2/3. \ No newline at end of file