laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-07-22 07:48:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update design docs for non-blocking transport connect and cleanup stale references

Browse Source 
- Rewrite TCP "Connect-on-Send" section to document non-blocking connect
  model (ConnectingPool, PendingConnect, poll_pending_connects)
- Add connect() and connection_state() to Transport trait surface
- Expand Connection Lifecycle section with ConnectionState enum
- Remove phantom TCP socks5_proxy field (removed from code, superseded
  by TorConfig)
- Fix "future Tor transport" references (stream reader already shared)
- Replace misleading "tor:" named TCP instance example
- Update fips-intro.md implementation status (TCP and Ethernet are
  implemented, not "under active design")
This commit is contained in:
Johnathan Corgan
2026-03-13 16:37:00 +00:00
parent 35ff4a5d0a
commit d873d0e00e
3 changed files with 58 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/design/fips-configuration.md
View File

@@ -359,7 +359,6 @@ overhead.
| `transports.tcp.recv_buf_size` | usize | `2097152` | Socket receive buffer size in bytes (2 MB) |
| `transports.tcp.send_buf_size` | usize | `2097152` | Socket send buffer size in bytes (2 MB) |
| `transports.tcp.max_inbound_connections` | usize | `256` | Maximum simultaneous inbound connections |
| `transports.tcp.socks5_proxy` | string | *(none)* | SOCKS5 proxy for outbound connections (implementation deferred) |
**Named instances.** Like other transports, multiple TCP instances can
be configured with named sub-keys:
@@ -369,9 +368,9 @@ transports:
tcp:
public:
bind_addr: "0.0.0.0:443"
tor:
socks5_proxy: "127.0.0.1:9050"
connect_timeout_ms: 30000
internal:
bind_addr: "10.0.0.1:8443"
max_inbound_connections: 64
```
## Peers (`peers[]`)
@@ -590,7 +589,6 @@ transports:
# recv_buf_size: 2097152 # 2 MB
# send_buf_size: 2097152 # 2 MB
# max_inbound_connections: 256 # resource protection limit
# socks5_proxy: null # SOCKS5 for outbound (deferred)
peers: # static peer list
# - npub: "npub1..."