How nagyzoltanpeter/nim-brokers works
nim-brokers lets a Nim interface declaration serve as a typed contract across in-process, cross-thread, and cross-language boundaries. The principal workflow is: declare a broker/interface, register an implementation or handler, then invoke it through the selected dispatch lane; optional API generation exposes the contract to foreign-language callers, while EXTAPI lets Nim consume foreign plugins. The README documents these capabilities, but the only sampled source is the EXTAPI ABI header, so detailed internal call relationships are not asserted.
Main entry points: api_library.nim API shared library · ext_runtime.nim External plugin runtime · broker_implement.nim Broker implementation · internal Threaded dispatch
Components 20
Contracts and lifecycle
- Broker interface
brokers/broker_interface.nim - Broker implementation
brokers/broker_implement.nim - Broker context
brokers/broker_context.nim - Broker scope
brokers/broker_scope.nim
Broker dispatch
- Request broker
brokers/request_broker.nim - Multi-request broker
brokers/multi_request_broker.nim - Event broker
brokers/event_broker.nim - Signal broker
brokers/signal_broker.nim - Threaded dispatch
brokers/internal
Foreign-language interop
- API shared library
brokers/api_library.nim - API schema and codecs
brokers/internal - Wrapper generation
brokers/internal - External plugin runtime
brokers/internal/ext_runtime.nim - EXTAPI broker integration
brokers/internal/ext_brokers.nim - Plugin interface
brokers/ext_plugin.nim
Dispatch internals
- CBOR transport
brokers/internal - Thread queues and transport
brokers/internal
Other components
- Nim consumer
- Foreign-language callers
- Foreign plugin
Connections 20
- Nim consumer → Broker interface: declares contract
README.md - Nim consumer → Broker implementation: implements contract
README.md - Broker implementation → Request broker: registers provider
README.md - Nim consumer → Request broker: sends request
README.md - Nim consumer → Multi-request broker: fans out requests
README.md - Nim consumer → Event broker: emits or listens
README.md - Nim consumer → Signal broker: sends signal
README.md - Nim consumer → Broker context: isolates brokers
README.md - Nim consumer → Broker scope: scopes registrations
README.md - Nim consumer → Threaded dispatch: selects thread lane
README.md - Threaded dispatch → Thread queues and transport: uses ring and slab
README.md - Nim consumer → API shared library: selects API lane
README.md - API shared library → API schema and codecs: uses CBOR ABI
README.md - API shared library → Wrapper generation: generates wrappers
README.md - Wrapper generation → Foreign-language callers: exposes typed API
README.md - Nim consumer → EXTAPI broker integration: declares EXTAPI
README.md - EXTAPI broker integration → External plugin runtime: uses plugin runtime
- External plugin runtime → Foreign plugin: tunnels plugin calls
- External plugin runtime → CBOR transport: transfers CBOR
- Plugin interface → Foreign plugin: implements plugin ABI