forge_worker_sdk/
lib.rs

1//! Organizyio **Forge** — Rust-side building blocks for local worker processes.
2//!
3//! This crate provides everything a product worker binary needs to participate
4//! in the Forge IPC protocol with a Go supervisor.  It intentionally contains
5//! no Archivist / UFIS scan types — those live in `organizy-worker`.
6//!
7//! ## Quick-start
8//!
9//! ```rust,ignore
10//! use forge_worker_sdk::{dispatcher::{WorkerHandler, ok_response, unknown_method}, framing::Encoding,
11//!                 job_registry::{EventSender, JobRegistry}, protocol::WireResponse, server};
12//! use std::sync::Arc;
13//!
14//! struct MyHandler;
15//! impl WorkerHandler for MyHandler {
16//!     fn worker_version(&self) -> &str { env!("CARGO_PKG_VERSION") }
17//!     fn features(&self) -> Vec<String> { vec![] }
18//!     fn handle_method(&self, req_id: &str, method: &str, params: Option<serde_json::Value>,
19//!                      _event_tx: EventSender, _registry: Arc<JobRegistry>) -> WireResponse {
20//!         unknown_method(req_id, method)
21//!     }
22//! }
23//!
24//! #[tokio::main]
25//! async fn main() -> anyhow::Result<()> {
26//!     server::run_worker("/tmp/my-worker.sock", MyHandler, Encoding::Msgpack).await
27//! }
28//! ```
29//!
30//! ## Modules
31//!
32//! - [`framing`]      — `FrameCodec` (Tokio `Decoder`/`Encoder`) + `Frame` enum.
33//! - [`protocol`]     — `WireRequest` / `WireResponse` / `WireEvent` + control types.
34//! - [`job_registry`] — Thread-safe job tracking with cancel tokens and event routing.
35//! - [`dispatcher`]   — `WorkerHandler` trait + `BaseDispatcher` (control-plane handling).
36//! - [`server`]       — `run_worker` entry point; Unix socket + Windows named pipe.
37//! - [`prelude`]      — `run_worker`, `WorkerHandler`, `Encoding`, `ErrorPayload` for quick imports.
38
39pub mod dispatcher;
40pub mod framing;
41pub mod job_registry;
42pub mod prelude;
43pub mod protocol;
44pub mod server;
45
46// Flat re-exports for the most commonly needed items
47pub use framing::{Encoding, Frame, FrameCodec, KIND_EVENT, KIND_REQUEST, KIND_RESPONSE, MAX_FRAME_PAYLOAD};
48pub use job_registry::{cancel_pair, CancelSignal, CancelToken, EventSender, JobRegistry, JobState, JobStatus};
49pub use dispatcher::{err_response, ok_response, unknown_method, WorkerHandler};
50pub use server::run_worker;
forge_worker_sdk/lib.rs

forge_worker_sdk/
lib.rs
