Skip to main content

Module framework

Module framework 

Expand description

Plugin framework for attaching custom runtime hooks. Public plugin framework surface for embedding custom observers into SOF runtime.

Re-exports§

pub use crate::event::ForkSlotStatus;
pub use crate::event::TxCommitmentStatus;
pub use derived_state::AccountTouchObservedEvent;
pub use derived_state::BranchReorgedEvent;
pub use derived_state::CheckpointBarrierEvent;
pub use derived_state::CheckpointBarrierReason;
pub use derived_state::DerivedStateCheckpoint;
pub use derived_state::DerivedStateCheckpointStore;
pub use derived_state::DerivedStateConsumer;
pub use derived_state::DerivedStateConsumerFault;
pub use derived_state::DerivedStateConsumerFaultKind;
pub use derived_state::DerivedStateConsumerRecoveryState;
pub use derived_state::DerivedStateConsumerTelemetry;
pub use derived_state::DerivedStateControlPlaneQuality;
pub use derived_state::DerivedStateControlPlaneStateEvent;
pub use derived_state::DerivedStateFeedEnvelope;
pub use derived_state::DerivedStateFeedEvent;
pub use derived_state::DerivedStateFreshnessState;
pub use derived_state::DerivedStateHost;
pub use derived_state::DerivedStateHostBuilder;
pub use derived_state::DerivedStateInputFreshness;
pub use derived_state::DerivedStateInvalidationEvent;
pub use derived_state::DerivedStateInvalidationReason;
pub use derived_state::DerivedStatePersistedCheckpoint;
pub use derived_state::DerivedStateRecoveryReport;
pub use derived_state::DerivedStateReplayBackend;
pub use derived_state::DerivedStateReplayDurability;
pub use derived_state::DerivedStateReplayError;
pub use derived_state::DerivedStateReplaySource;
pub use derived_state::DerivedStateReplayTelemetry;
pub use derived_state::DerivedStateTxOutcomeEvent;
pub use derived_state::DerivedStateTxOutcomeKind;
pub use derived_state::DiskDerivedStateReplaySource;
pub use derived_state::FeedSequence;
pub use derived_state::FeedSessionId;
pub use derived_state::FeedWatermarks;
pub use derived_state::InMemoryDerivedStateReplaySource;
pub use derived_state::SlotStatusChangedEvent;
pub use derived_state::TransactionAppliedEvent;
pub use events::AccountTouchEvent;
pub use events::AccountTouchEventRef;
pub use events::ClusterNodeInfo;
pub use events::ClusterTopologyEvent;
pub use events::ControlPlaneSource;
pub use events::DatasetEvent;
pub use events::LeaderScheduleEntry;
pub use events::LeaderScheduleEvent;
pub use events::ObservedRecentBlockhashEvent;
pub use events::RawPacketEvent;
pub use events::ReorgEvent;
pub use events::ShredEvent;
pub use events::SlotStatusEvent;
pub use events::TransactionEvent;
pub use events::TransactionEventRef;
pub use extension::ExtensionCapability;
pub use extension::ExtensionManifest;
pub use extension::ExtensionResourceSpec;
pub use extension::ExtensionShutdownContext;
pub use extension::ExtensionStartupContext;
pub use extension::ExtensionStreamVisibility;
pub use extension::PacketSubscription;
pub use extension::RuntimeExtension;
pub use extension::RuntimePacketEvent;
pub use extension::RuntimePacketEventClass;
pub use extension::RuntimePacketSource;
pub use extension::RuntimePacketSourceKind;
pub use extension::RuntimePacketTransport;
pub use extension::RuntimeWebSocketFrameType;
pub use extension::TcpConnectorSpec;
pub use extension::TcpListenerSpec;
pub use extension::UdpListenerSpec;
pub use extension::WsConnectorSpec;
pub use extension_host::RuntimeExtensionCapabilityPolicy;
pub use extension_host::RuntimeExtensionDispatchMetrics;
pub use extension_host::RuntimeExtensionHost;
pub use extension_host::RuntimeExtensionHostBuilder;
pub use extension_host::RuntimeExtensionStartupFailure;
pub use extension_host::RuntimeExtensionStartupReport;
pub use host::PluginDispatchMode;
pub use host::PluginHost;
pub use host::PluginHostBuilder;
pub use plugin::ObserverPlugin as Plugin;
pub use plugin::ObserverPlugin;
pub use plugin::TransactionInterest;

Modules§

derived_state
Experimental derived-state feed scaffold for official stateful extensions. Experimental derived-state feed types for official stateful extensions.
events
Framework event payload types delivered to plugins.
extension
Runtime extension trait and manifest/filter/resource types.
extension_host
Runtime extension host builder and dispatcher. Runtime host for packet-oriented extensions and their resource adapters.
host
Plugin host builder and dispatcher.
plugin
Plugin trait implemented by user extensions.