first commit
This commit is contained in:
26
docs/networking/network/network-plugin-relay/README.md
Normal file
26
docs/networking/network/network-plugin-relay/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# @suaveplan/network-plugin-relay - Cross-mesh relay: relay router, host-backbone transport, cross-mesh envelope schema, mesh directory, loop-prevention guard, manager
|
||||
|
||||
## Summary
|
||||
|
||||
Cross-mesh relay — the federation layer that lets Tier 0 hosts of different meshes route messages to each other. Composes `RelayRouter`, `HostBackboneTransport` (Tier 0 ↔ Tier 0), `CrossMeshEnvelope` (Zod-validated), `MeshDirectory` (host lookup), `LoopGuard` (hopCount/ttl/visitedNodes), and `RelayManager` (plugin entry point).
|
||||
|
||||
<!-- begin:auto-docs -->
|
||||
## Documentation tree
|
||||
|
||||
- [backbone](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [host-backbone-transport](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [mesh-directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [cross-mesh-envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [loop-prevention](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [loop-guard](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [relay-manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [relay-router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [error-codes](./src/error-codes.md) — Frozen registry of error codes for the network-plugin-relay plugin. Five codes cover the full surface: `ROUTE_NOT_FOUND…
|
||||
<!-- end:auto-docs --> - [host-backbone-transport](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_- [directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [mesh-directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [cross-mesh-envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-prevention](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-guard](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of error codes for the network-plugin-relay plugin. Five codes cover the full surface: `ROUTE_NOT_FOUND…
|
||||
- [host-backbone-transport](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_- [directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [mesh-directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [cross-mesh-envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-prevention](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-guard](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of error codes for the network-plugin-relay plugin. Five codes cover the full surface: `ROUTE_NOT_FOUND…
|
||||
- [host-backbone-transport](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_- [directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [mesh-directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [cross-mesh-envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-prevention](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-guard](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [relay-router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of error codes for the network-plugin-relay plugin. Five codes cover the full surface: `ROUTE_NOT_FOUND…
|
||||
- [host-backbone-transport](./src/backbone/host-backbone-transport.md) — <!-- begin:auto-docs --> _(no submodules)_- [directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_ - [mesh-directory](./src/directory/mesh-directory.md) — <!-- begin:auto-docs --> _(no submodules)_- [envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_ - [cross-mesh-envelope](./src/envelope/cross-mesh-envelope.md) — <!-- begin:auto-docs --> _(no submodules)_- [loop-prevention](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_ - [loop-guard](./src/loop-prevention/loop-guard.md) — <!-- begin:auto-docs --> _(no submodules)_- [manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ - [relay-manager](./src/manager/relay-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_ - [relay-router](./src/router/relay-router.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of error codes for the network-plugin-relay plugin. Five codes cover the full surface: `ROUTE_NOT_FOUND…
|
||||
Reference in New Issue
Block a user