Expand description
Portable blocking Arachne session runtime shared by native clients and language bindings. No membership API is implied by creating an authenticated transport endpoint.
Modules§
- admission_
state - Stable host-facing vocabulary for the admission lifecycle.
Structs§
- Admission
Authorization - Admission
Reply - Client
- Typed adopter seam over the portable runtime. The JSON dispatcher remains private to adapters; consumers use typed lifecycle operations here.
- Client
Config - Configuration for one workspace-facing runtime client.
- Connection
Capacity Metrics - Connectivity
Report - Control
Timing Metrics - Delivery
Failure - Delivery
Report - Duration
Summary - A duration series measured in microseconds since the endpoint started.
- Endpoint
Info - Error
- Interest
Observation - Invitation
Details - Invitation
Info - Join
Admission Step - Join
Request - Member
Info - Member
Roster - Membership
Gossip Metrics - Peer
Policy - Peer
Route - Publication
- Publication
Candidate - Recovered
Publication - Recovery
Adoption - Recovery
Candidate - Recovery
Range Ready - Recovery
Range Request - Route
Hint - Workspace
Activity - The one restart-safe workspace lifecycle value. Membership and delivery details remain separate projections; this value only answers where the workspace operation is and why it stopped.
- Workspace
Candidate - Workspace
Info - Workspace
Metrics - A bounded, read-only snapshot for native adapters and diagnostics.
- Workspace
State
Enums§
- Error
Kind - Member
Kind - Network
- Address discovery and transport selection for a typed runtime client.
- Presence
- Recovery
Range Status - Recovery
Stage - Route
Kind - Workspace
Phase - Durable lifecycle phases projected to every adapter.
Constants§
- MAX_
REQUEST - Maximum JSON request or metadata size in bytes.
Functions§
- cancel
- Interrupt outbound control exchanges. The owner still calls
closeto release the endpoint once its serial JNI request returns. - close
- Stop a session and release its transport, tasks and runtime.
- create
- Create an endpoint session. Credentials must be unique to this workspace-facing endpoint.
Blocking: invoke outside an async runtime. Call
closeto release its resources. - create_
lan - Opt in to local endpoint advertisement and lookup. No public discovery or relay. Uses the supplied workspace-scoped identity; discovery does not grant membership.
- create_
nearby - Advertise a device-level nearby-invitation endpoint on the local network.
- create_
relay - Force Iroh relay paths for a diagnostic WAN check while preserving the caller’s network connection and workspace-scoped endpoint identity.
- create_
relay_ with_ options - Use a caller-supplied relay map for controlled qualification or an operator-managed relay deployment.
- create_
wan - Opt in to Iroh’s public Pkarr lookup and relay network, with LAN discovery retained as a local fallback. External services provide routes, not authority.
- create_
wan_ only - Use public endpoint lookup without LAN discovery or saved address hints. Direct Iroh paths remain enabled for a diagnostic WAN check.
- describe
- Return endpoint metadata for a live session.
- enable_
record_ storage - Atomically migrate the current accepted owner and delivery state into an empty record store. The host supplies a private path and protected storage root and must retain its endpoint credential lock. Existing stores require restore; never overwrite one with an older legacy snapshot or fall back on open failure. A pending join may migrate too; admission atomically replaces its records. Host route/unknown-outcome metadata remains separate and must be preserved.
- execute
- Execute a bounded JSON request. Staged security changes require save/readback/adopt.
- execute_
stored - Execute metadata with a binary snapshot; return metadata and snapshot separately. The caller must durably save and read back staged snapshots before adopting them.
- inspect_
invitation - Verify invitation presentation without allocating an endpoint or join identity.
- restore_
record_ storage - Restore only the authoritative native store into an empty endpoint session. Failure must not trigger legacy fallback. Removal consumes the session.
- save_
candidate - Commit the exact staged candidate, including counters and delivery state. This does not adopt, send, reply or release application data. Retry after a successful commit is idempotent; callers still invoke the matching adoption.
- wait_
for_ work - Park the calling thread until this session may have work, without holding the
session lock.
Ok(true): drain withpoll_admissionuntil it returns null, then call again.Ok(false): the session closed. Spurioustrueis allowed.