Skip to main content

Crate taktora_executor

Crate taktora_executor 

Source
Expand description

§taktora-executor

Execution framework on top of iceoryx2. Provides:

See the workspace README.md for a quick-start.

Modules§

signal_slot
signal_slot::pair — pre-built ExecutableItems wrapping a Channel<T>.

Structs§

ActiveRequest
A received request, used to send the response.
Channel
Pub/sub channel with a paired event service.
Client
Client side of a Service<Req, Resp>. Sends requests and receives responses.
Conditional
Conditional wrapper produced by wrap_with_condition.
Context
Per-invocation context. Borrowed view; not stored across calls.
Executor
Top-level executor. One per process is the typical case.
ExecutorBuilder
Builder for Executor.
ExecutorGraphBuilder
Borrowed wrapper that finalises a GraphBuilder into a registered task.
FnItem
Adapter turning a closure into an ExecutableItem with no triggers declared. Use item_with_triggers when triggers are needed.
FnItemWithTriggers
Wrap a pair of closures (declare, execute) as an ExecutableItem.
GraphBuilder
Builder for a graph.
NotifyOutcome
Outcome of a Publisher send operation.
PendingRequest
Handle to an in-flight request — receives the matching response(s).
Publisher
Pub/sub publisher that auto-notifies the paired event service on every send.
Runner
Hosts an Executor on a dedicated thread.
RunnerFlags
Behaviour flags for Runner.
Server
Server side of a Service<Req, Resp>. Receives requests and sends responses.
Service
Request/response service with two paired event services for wakeup.
Stoppable
Shared stop flag passed via Context::stoppable.
Subscriber
Pub/sub subscriber. Carries the paired event listener as Arc<Listener> so the executor can attach it to its WaitSet.
TaskId
Identifier for a task added to an Executor.
ThreadAttributesNon-thread_attrs
Disabled stub. Enable the thread_attrs feature for real settings.
TriggerDeclarer
Records trigger intentions. Consumed by the executor at add-time.
UserEvent
Generic user event carried by Observer::on_send_event.
Vertex
Opaque handle to a graph vertex. Returned by GraphBuilder::vertex.

Enums§

ControlFlow
What the executor should do after an item runs successfully.
ExecutorError
Top-level error type for the executor.

Constants§

EVENT_SUFFIX
Suffix appended to a topic name to form the paired event-service name.
REQ_EVENT_SUFFIX
Suffix appended to a service name to form the request-available event service name.
RESP_EVENT_SUFFIX
Suffix appended to a service name to form the response-available event service name.

Traits§

ExecutableItem
Trait implemented by every unit of work the executor schedules.
ExecutionMonitor
Hook invoked before and after every execute call. Defaults are no-ops.
Observer
Lifecycle observer invoked by the executor at well-defined points.
Payload
Marker trait for types that can be carried over a Channel<T> or Service<Req, Resp> — i.e., types that are ZeroCopySend + Debug + 'static.

Functions§

item
Wrap a closure as an ExecutableItem.
item_with_triggers
Wrap a (declare, execute) pair as an ExecutableItem.
wrap_with_condition
Wraps item so that, on each invocation, cond() runs first. If cond returns false, the wrapper returns Ok(StopChain) and item.execute is not called.

Type Aliases§

ExecuteResult
Return type of crate::ExecutableItem::execute.
ItemError
Type alias for user-supplied item errors. Boxed dyn Error so callers can plug in any error type without forcing this crate to know about it.
RawListener
Listener type the rest of the crate manipulates. Aliased so client code using RawListener keeps working if iceoryx2 renames its types.