Correct documentation for bridge mode tunnel channel handling

- Fixed documentation to correctly state that in bridge mode:
  - Tunnel control channel messages are communicated through stdin/stdout (JSON protocol)
  - Tunnel data channel messages remain handled by wsssht (normal forwarding)
- Updated README.md, DOCUMENTATION.md, CHANGELOG.md, and TODO.md
- The implementation was already correct, just the documentation was backwards
parent fb7f4986
...@@ -18,8 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ...@@ -18,8 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Real-time JSON status updates during tunnel establishment - Real-time JSON status updates during tunnel establishment
- Command processing from stdin with JSON responses - Command processing from stdin with JSON responses
- Structured error reporting and connection status - Structured error reporting and connection status
- **Tunnel control channel messages are handled by wsssht** - **Tunnel control channel messages are communicated through stdin/stdout** (JSON protocol)
- **Tunnel data channel messages are NOT handled by wsssht** - instead, raw data is communicated through stdin/stdout for external processing - **Tunnel data channel messages remain handled by wsssht** (normal forwarding)
- Perfect for programmatic integration and automation - Perfect for programmatic integration and automation
- **Script Mode Implementation**: JSON protocol for scripting - **Script Mode Implementation**: JSON protocol for scripting
- Periodic status updates (every 30 seconds) - Periodic status updates (every 30 seconds)
......
...@@ -73,11 +73,11 @@ wsssht --bridge --clientid myclient --wssshd-host example.com ...@@ -73,11 +73,11 @@ wsssht --bridge --clientid myclient --wssshd-host example.com
Provides a JSON-based interface for programmatic integration: Provides a JSON-based interface for programmatic integration:
- Receives JSON commands from stdin - Receives JSON commands from stdin
- Sends JSON status updates and responses to stdout - Sends JSON status updates and responses to stdout
- **Tunnel control channel messages are handled by wsssht** - **Tunnel control channel messages are communicated through stdin/stdout** (JSON protocol)
- **Tunnel data channel messages are NOT handled by wsssht** - instead, raw data is communicated through stdin/stdout for external processing - **Tunnel data channel messages remain handled by wsssht** (normal forwarding)
- Perfect for integration with other tools and automation frameworks - Perfect for integration with other tools and automation frameworks
- Structured error reporting and connection status updates - Structured error reporting and connection status updates
- External applications can directly handle the data stream - External applications can control the tunnel via JSON commands
### Script Mode ### Script Mode
```bash ```bash
......
...@@ -232,7 +232,7 @@ Suppresses all informational output, perfect for scripts and automation. ...@@ -232,7 +232,7 @@ Suppresses all informational output, perfect for scripts and automation.
``` ```
JSON-based communication over stdin/stdout for programmatic use. Receives JSON commands from stdin and sends JSON responses to stdout. JSON-based communication over stdin/stdout for programmatic use. Receives JSON commands from stdin and sends JSON responses to stdout.
**Important**: In bridge mode, wsssht handles tunnel control channel messages but does NOT handle tunnel data channel messages. Instead, raw tunnel data is communicated through stdin/stdout for external processing by the calling application. **Important**: In bridge mode, tunnel control channel messages are communicated through stdin/stdout (JSON protocol), while tunnel data channel messages remain handled by wsssht through normal forwarding.
### Script Mode ### Script Mode
```bash ```bash
......
...@@ -11,8 +11,8 @@ ...@@ -11,8 +11,8 @@
- Real-time JSON status updates during tunnel establishment - Real-time JSON status updates during tunnel establishment
- Command processing from stdin with JSON responses - Command processing from stdin with JSON responses
- Structured error reporting and connection status - Structured error reporting and connection status
- **Tunnel control channel messages are handled by wsssht** - **Tunnel control channel messages are communicated through stdin/stdout** (JSON protocol)
- **Tunnel data channel messages are NOT handled by wsssht** - instead, raw data is communicated through stdin/stdout for external processing - **Tunnel data channel messages remain handled by wsssht** (normal forwarding)
- Perfect for programmatic integration and automation - Perfect for programmatic integration and automation
- [x] **Script Mode Implementation**: JSON protocol for scripting - [x] **Script Mode Implementation**: JSON protocol for scripting
- Periodic status updates (every 30 seconds) - Periodic status updates (every 30 seconds)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment