Struct PluginHandler 

pub struct PluginHandler<CTP: ConnectionToPlugin> { /* private fields */ }

The core structure handling the pluginization of connections.

Implementations

impl<CTP: ConnectionToPlugin> PluginHandler<CTP>

pub fn new( exports_func: fn(&mut Store, &FunctionEnv<Env<CTP>>) -> Exports, ) -> Self

Create a new PluginHandler, enabling the execution of plugins inserted on the fly to customize the behavior of a connection.

pub fn set_pluginizable_connection( &mut self, conn: *const PluginizableConnection<CTP>, ) -> bool

Set the pointer to the connection context. This pointer must be pinned.

pub fn insert_plugin(&mut self, plugin_fname: &PathBuf) -> Result<(), Error>

Attach a new plugin whose bytecode is accessible through the provided path. Return whether the insertion succeeded, or the related Error otherwise.

If the insertion succeeds and the plugin provides an init function as a protocol operation, this function calls it. This can be useful to, e.g., initialize a plugin-specific structure or register new frames.

pub fn provides(&self, po: &PluginOp, anchor: Anchor) -> bool

Return whether there is a bytecode providing the plugin operation at the requested anchor.

pub fn timeout(&self) -> Option<Instant>

Return the first timeout event required by a plugin.

pub fn on_timeout(&mut self, t: Instant) -> Result<(), Error>

Call potential timeouts that fired since the provided time.

If there were not firing timers, this method does nothing.

pub fn get_conn(&self) -> Option<&PluginizableConnection<CTP>>

Get an immutable reference to the serving connection.

pub fn get_conn_mut(&mut self) -> Option<&mut PluginizableConnection<CTP>>

Get an mutable reference to the serving connection.

pub fn add_bytes_content(&mut self, bc: BytesContent) -> Bytes

Set bytes content, to be available through a Bytes value by the plugin.

pub fn clear_bytes_content(&mut self)

Clear the content made available to the plugin.

This method must always be called once the plugin operation call completes. This is automatically done by the helping macros.

pub fn add_registration(&mut self, r: Registration)

Register some plugin Registration.

pub fn get_registrations(&self) -> &[Registration]

Return all the Registrations that are known by the pluginization handler.

pub fn call_direct( &mut self, po: &PluginOp, anchor: Anchor, params: &[PluginVal], ) -> Result<(), Error>

Only for BEFORE or AFTER calls.

pub fn call( &mut self, po: &PluginOp, params: &[PluginVal], ) -> Result<Vec<PluginVal>, Error>

Invokes the plugin operation po and runs its anchors.

pub fn poctl( &mut self, id: u64, params: &[PluginVal], ) -> Result<Vec<PluginVal>, Error>

Invokes a plugin operation control operation.

Trait Implementations

impl<CTP: ConnectionToPlugin> Debug for PluginHandler<CTP>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.