feat: update implementation roadmap with current status and remaining work

Author: datagutt

plans/05-implementation-roadmap.md

@@ -2,299 +2,89 @@
 
 ## Current Status (December 2024)
 
-**Overall Progress: ~70% complete**
+**Overall Progress: ~95% complete**
 
 | Phase | Status | Notes |
 |-------|--------|-------|
-| 1. Foundation | **Complete** | FFI bindings, CI, build system all working |
-| 2. Core Wrapper | **Complete** | Sender/Receiver with builders, peer management |
-| 3. Data Flow | **Complete** | DataBlock, send/recv working |
-| 4. Callbacks | **Mostly Complete** | Stats, connection, data, logging done; auth pending |
-| 5. Advanced | **Partial** | Stats done, encryption via URL; OOB/SRP not started |
-| 6. Async | **Not Started** | Planned for future |
-| 7. Documentation | **Partial** | README, examples done; needs more docs/tests |
+| 1. Foundation | **Complete** | FFI bindings, CI, build system |
+| 2. Core Wrapper | **Complete** | Sender/Receiver with builders |
+| 3. Data Flow | **Complete** | DataBlock, send/recv, NPD, NACK |
+| 4. Callbacks | **Complete** | Stats, connection, data, auth, OOB, logging |
+| 5. Advanced | **Complete** | Stats, OOB, encryption, bonding |
+| 6. Async | **Complete** | Tokio integration |
+| 7. Polish | **Partial** | Needs Windows CI, more tests |
 
-**Working Examples:** Sender and receiver examples tested successfully with live data transmission.
+**Test Suite:** 23 tests passing (19 librist, 4 librist-sys)
 
-**Test Suite:** 28 tests passing (16 librist, 4 librist-sys, 8 doc tests)
+**Examples:** sender, receiver, bonding_sender, stats_monitor, async_receiver, debug_recv
 
 ---
 
-## Overview
+## Remaining Work
 
-This document outlines the phased implementation plan for the librist-rust project.
+### High Priority
+- [ ] Windows CI testing
+- [ ] Integration tests with real network
+- [ ] crates.io publish preparation
 
-## Phase 1: Foundation (Week 1-2)
-
-### 1.1 Project Setup
-- [x] Create workspace structure
-- [x] Initialize git repository
-- [x] Set up GitHub Actions CI
-- [x] Configure Cargo workspace
-- [x] Add librist as git submodule
-
-### 1.2 librist-sys Crate
-- [x] Create build.rs with Meson integration
-- [x] Configure bindgen for header parsing
-- [x] Generate initial bindings
-- [x] Handle platform-specific linking
-- [x] Add basic tests (version, link)
-
-### 1.3 CI Pipeline
-- [x] Format checking
-- [x] Clippy linting
-- [x] Build on Linux x86_64
-- [x] Build on macOS (x86_64 + ARM64)
-- [ ] Build on Windows (not yet tested)
-
-**Deliverable:** Working librist-sys crate with bindings and CI
-
-## Phase 2: Core Wrapper (Week 3-4)
-
-### 2.1 Error Handling
-- [x] Define Error enum
-- [x] Implement error code mapping
-- [x] Add Result type alias
-
-### 2.2 Basic Types
-- [x] Profile enum
-- [x] LogLevel enum
-- [x] RecoveryMode enum
-- [x] ConnectionStatus enum
-- [x] Other enums and constants
-
-### 2.3 Context Types
-- [x] RistSender struct
-- [x] RistReceiver struct
-- [x] Context builders
-- [x] Start/stop lifecycle
-
-### 2.4 Peer Management
-- [x] PeerHandle struct
-- [x] PeerConfig struct
-- [x] URL parsing
-- [x] Peer creation/destruction
-
-**Deliverable:** Basic sender/receiver functionality
-
-## Phase 3: Data Flow (Week 5-6)
-
-### 3.1 Data Block
-- [x] DataBlock wrapper
-- [x] Payload access
-- [x] Metadata (timestamps, ports, flags)
-- [x] Proper cleanup (Drop impl)
-
-### 3.2 Sender Operations
-- [x] send() method
-- [x] send_to_port() method
-- [x] send_block() method
-- [ ] NPD control
-
-### 3.3 Receiver Operations
-- [x] recv() method (blocking)
-- [x] try_recv() method
-- [x] FIFO configuration
-- [ ] NACK type setting
-
-**Deliverable:** Full data transmission capability
-
-## Phase 4: Callbacks (Week 7-8)
-
-### 4.1 Callback Infrastructure
-- [x] Trampoline functions
-- [x] Closure storage (double-boxing for thin pointers)
-- [x] Panic handling
-- [x] Thread safety
-
-### 4.2 Sender Callbacks
-- [x] Stats callback
-- [x] Connection status callback
-
-### 4.3 Receiver Callbacks
-- [x] Data callback
-- [x] Stats callback
-- [x] Connection status callback
-- [x] Auth callback (connect and disconnect)
-
-### 4.4 Logging
-- [x] Log callback
-- [x] Integration with `log` crate
-- [ ] Optional `tracing` support (feature defined, not implemented)
-
-**Deliverable:** Full callback system
-
-## Phase 5: Advanced Features (Week 9-10)
-
-### 5.1 Statistics
-- [x] SenderStats struct
-- [x] ReceiverStats struct
-- [ ] JSON parsing (optional)
-- [ ] Stats aggregation
-
-### 5.2 Out-of-Band Data
-- [ ] OOB write
-- [ ] OOB read
-- [ ] OOB callback
-
-### 5.3 Encryption
-- [x] Secret configuration (via URL parameters)
-- [ ] Key rotation
-- [ ] SRP authentication (feature-gated)
-
-### 5.4 Bonding
-- [x] Weight configuration (via URL parameters)
-- [x] Multi-peer management
-- [ ] Adaptive bitrate support
-
-**Deliverable:** Production-ready feature set
-
-## Phase 6: Async Support (Week 11-12)
-
-### 6.1 Tokio Integration
-- [ ] async recv()
-- [ ] async send()
-- [ ] Channel-based data callback
-- [ ] Runtime management
-
-### 6.2 async-std Integration
-- [ ] Feature-gated implementation
-- [ ] Same API as Tokio
-
-### 6.3 Performance Optimization
+### Medium Priority
 - [ ] Benchmark suite
-- [ ] Memory optimization
-- [ ] Latency analysis
-
-**Deliverable:** Async-ready library
-
-## Phase 7: Documentation & Polish (Week 13-14)
+- [ ] Test coverage improvements
+- [ ] OOB peer targeting (TODO in code)
 
-### 7.1 Documentation
-- [x] Crate-level docs
-- [x] Module-level docs
-- [x] All public items documented
-- [x] Examples in docs
+### Low Priority
+- [ ] SRP authentication
+- [ ] async-std support
 
-### 7.2 Examples
-- [x] Simple sender example
-- [x] Simple receiver example
-- [x] Bonding example
-- [ ] Async example
-- [x] Stats monitoring example
-
-### 7.3 Testing
-- [x] Unit tests (28 passing)
-- [ ] Unit test coverage > 80%
-- [ ] Integration tests
-- [ ] Stress tests
-- [ ] Memory leak tests
+---
 
-### 7.4 Release Preparation
-- [ ] Changelog
-- [x] License verification (MIT)
-- [ ] crates.io metadata
-- [ ] GitHub release automation
+## Completed Features
+
+### Core
+- RistSender / RistReceiver with builder pattern
+- Profile, LogLevel, RecoveryMode, ConnectionStatus enums
+- PeerHandle, PeerConfig, URL parsing
+- Error handling with Result type
+
+### Data Flow
+- DataBlock with metadata (timestamps, ports, flags)
+- send(), send_to_port(), send_block()
+- recv(), try_recv()
+- NPD (Null Packet Deletion): enable_npd(), disable_npd()
+- NACK type configuration: set_nack_type()
+
+### Callbacks
+- Stats callbacks (sender + receiver)
+- Connection status callbacks
+- Data callback (receiver)
+- Auth callbacks (connect + disconnect)
+- OOB callbacks (sender + receiver)
+- Log callback with `log` and `tracing` crate integration
+
+### Advanced
+- OOB send/receive: send_oob(), send_oob_block(), on_oob()
+- Encryption via URL parameters
+- Bonding via weight configuration
+- Statistics: SenderStats, ReceiverStats
+
+### Async (feature: async-tokio)
+- AsyncRistSender: send(), send_to_port(), send_bulk()
+- AsyncRistReceiver: recv(), recv_timeout(), try_recv()
+- Stream trait for use with StreamExt
 
-**Deliverable:** Published crates
+---
 
 ## Quality Gates
 
-### Per-Phase Gates
-
-Each phase must meet these criteria before proceeding:
-
-1. **All tests pass** on all CI platforms
-2. **No Clippy warnings** (with -D warnings)
-3. **Documentation** for all new public items
-4. **Code review** approved
-
-### Release Gates
-
 Before v1.0 release:
-
-1. **Security audit** clean (cargo audit)
-2. **MSRV** verified (Rust 1.85+)
-3. **API stability** reviewed
-4. **Performance** benchmarked
-5. **Real-world testing** with actual RIST streams
-
-## Risk Mitigation
-
-### Technical Risks
-
-| Risk | Mitigation |
-|------|------------|
-| librist API changes | Pin to specific version, maintain compatibility layer |
-| Platform-specific issues | Extensive CI matrix, community testing |
-| Memory safety in FFI | Careful review, MIRI testing, fuzzing |
-| Callback lifetime issues | Conservative lifetime bounds, extensive testing |
-
-### Schedule Risks
-
-| Risk | Mitigation |
-|------|------------|
-| Build system complexity | Start early, iterate, seek community help |
-| Platform quirks | Parallel development on all platforms |
-| Feature creep | Strict scope management, MVP focus |
-
-## Success Metrics
-
-### Technical Metrics
-- Build time < 2 minutes
-- Test coverage > 80%
-- Zero memory leaks in valgrind
-- Latency overhead < 100us
-
-### Adoption Metrics
-- Successful integration in 2+ projects
-- Positive community feedback
-- Documentation rated helpful
+1. All tests pass on Linux, macOS, Windows
+2. No Clippy warnings
+3. Documentation for all public items
+4. Security audit clean (cargo audit)
+5. Real-world testing with RIST streams
 
 ## Dependencies
 
-### Required
-- Rust 1.85+ (MSRV, Rust 2024 edition)
-- Meson 0.54+
-- Ninja
-- C compiler (gcc/clang/MSVC)
-
-### Optional
-- mbedTLS (bundled by default)
-- OpenSSL (alternative encryption)
-- lz4 (for compression)
-
-## Team Responsibilities
-
-For a solo project, all responsibilities are on the maintainer:
-- Architecture decisions
-- Implementation
-- Testing
-- Documentation
-- Release management
-- Community support
-
-## Timeline Summary
-
-| Phase | Duration | Milestone | Status |
-|-------|----------|-----------|--------|
-| 1. Foundation | 2 weeks | Working bindings | **Done** |
-| 2. Core Wrapper | 2 weeks | Basic sender/receiver | **Done** |
-| 3. Data Flow | 2 weeks | Full transmission | **Done** |
-| 4. Callbacks | 2 weeks | Event handling | **Done** |
-| 5. Advanced | 2 weeks | Production features | Partial |
-| 6. Async | 2 weeks | Async support | Not Started |
-| 7. Polish | 2 weeks | Release ready | Partial |
-
-**Total: 14 weeks to v1.0**
-
-## Next Steps
-
-Priority items for continued development:
+**Required:** Rust 1.85+, Meson 0.54+, Ninja, C compiler
 
-1. **Auth callback** - Complete Phase 4
-2. **NPD control / NACK type setting** - Complete Phase 3
-3. **More examples** - Bonding, stats monitoring
-4. **Integration tests** - Real network testing
-5. **Async support** - Tokio integration
-6. **Windows CI** - Complete platform coverage
+**Optional:** mbedTLS (bundled), OpenSSL, lz4