alkdev/alknet
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(interface): document SshSession recv/send stubs as planned future work

Browse Source 
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.
This commit is contained in:
glm-5.1
2026-06-08 05:35:43 +00:00
parent 64c54b965e
commit 5cac68f95c
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/alknet-core/src/interface/ssh.rs
View File

@@ -586,10 +586,18 @@ impl SshSession {
#[async_trait] #[async_trait]
impl InterfaceSession for SshSession { 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<InterfaceEvent> { async fn recv(&mut self) -> Option<InterfaceEvent> {
None 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<()> { async fn send(&mut self, _envelope: EventEnvelope) -> Result<()> {
Ok(()) Ok(())
} }

4
tasks/cleanup/ssh-session-recv-stub-doc.md
View File

@@ -1,7 +1,7 @@
--- ---
id: cleanup/ssh-session-recv-stub-doc id: cleanup/ssh-session-recv-stub-doc
name: Document SshSession::recv() stub as planned future work name: Document SshSession::recv() stub as planned future work
status: pending status: completed
depends_on: depends_on:
- review/phase1-core-modifications - review/phase1-core-modifications
scope: single scope: single
@@ -38,4 +38,4 @@ This is acceptable for Phase 1 (tunnel functionality still works via the existin
## Summary ## Summary
> To be filled on completion > 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.