first commit
This commit is contained in:
32
docs/networking/network/network-plugin-state/README.md
Normal file
32
docs/networking/network/network-plugin-state/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# @suaveplan/network-plugin-state - Mesh-wide synchronized state with delta compression, path-specific conflict resolution, Bloom-filter divergence detection, and resource-aware sync
|
||||
|
||||
## Summary
|
||||
|
||||
Mesh-wide synchronized state for the Suaveplan network. Path-based `StateManager` (versioned history with sequence numbers + per-path subscriptions); `DeltaCompressor` computing structural deltas between snapshots with round-trip verification; `StateReconciler` covering the five strategies (`latest-wins` / `remote-wins` / `local-wins` / `deep-merge` / `custom`) with `PathStrategyRegistry` so different parts of the tree honour different policies; `BloomFilterComparator` for compact divergence detection; `StateSyncEngine` orchestrating full-state sync for new peers and delta sync for existing peers; `ResourceAdapter` mapping the four device profiles (`EDGE` / `MOBILE` / `DESKTOP` / `CLOUD`) to compression / retention / sync-frequency knobs; `StateHistoryPruner` enforcing retention windows and memory bounds. Wrapped in a single `StatePlugin` satisfying the `NetworkPlugin` lifecycle.
|
||||
|
||||
<!-- begin:auto-docs -->
|
||||
## Documentation tree
|
||||
|
||||
- [bloom](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [bloom-filter-comparator](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [delta](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [delta-compressor](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state-plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state-history-pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state-reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [resource](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [resource-adapter](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state-manager](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [strategy](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [path-strategy-registry](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [sync](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [state-sync-engine](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [error-codes](./src/error-codes.md) — Frozen registry of every error code raised by the state package. Codes are namespaced under `NET_STATE` and registered…
|
||||
<!-- end:auto-docs --> - [bloom-filter-comparator](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta-compressor](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-history-pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource-adapter](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [state](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-manager](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [strategy](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [path-strategy-registry](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [sync](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-sync-engine](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of every error code raised by the state package. Codes are namespaced under `NET_STATE` and registered…
|
||||
- [bloom-filter-comparator](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta-compressor](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-history-pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource-adapter](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [state](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-manager](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [strategy](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [path-strategy-registry](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [sync](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-sync-engine](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of every error code raised by the state package. Codes are namespaced under `NET_STATE` and registered…
|
||||
- [bloom-filter-comparator](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta-compressor](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-history-pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource-adapter](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [state](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-manager](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [strategy](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [path-strategy-registry](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [sync](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [state-sync-engine](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of every error code raised by the state package. Codes are namespaced under `NET_STATE` and registered…
|
||||
- [bloom-filter-comparator](./src/bloom/bloom-filter-comparator.md) — <!-- begin:auto-docs --> _(no submodules)_- [delta](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_ - [delta-compressor](./src/delta/delta-compressor.md) — <!-- begin:auto-docs --> _(no submodules)_- [plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_ - [state-plugin](./src/plugin/state-plugin.md) — <!-- begin:auto-docs --> _(no submodules)_- [pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_ - [state-history-pruner](./src/pruner/state-history-pruner.md) — <!-- begin:auto-docs --> _(no submodules)_- [reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_ - [state-reconciler](./src/reconciler/state-reconciler.md) — <!-- begin:auto-docs --> _(no submodules)_- [resource](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_ - [resource-adapter](./src/resource/resource-adapter.md) — <!-- begin:auto-docs --> _(no submodules)_- [state](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_ - [state-manager](./src/state/state-manager.md) — <!-- begin:auto-docs --> _(no submodules)_- [strategy](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_ - [path-strategy-registry](./src/strategy/path-strategy-registry.md) — <!-- begin:auto-docs --> _(no submodules)_- [sync](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_ - [state-sync-engine](./src/sync/state-sync-engine.md) — <!-- begin:auto-docs --> _(no submodules)_- [error-codes](./src/error-codes.md) — Frozen registry of every error code raised by the state package. Codes are namespaced under `NET_STATE` and registered…
|
||||
Reference in New Issue
Block a user