Struct PluginGc

pub struct PluginGc { /* private fields */ }

Plugin garbage collector

Many users don’t want all of their plugins to stay running indefinitely after using them, so this runs a thread that monitors the plugin’s usage and stops it automatically if it meets certain conditions of inactivity.

Implementations

impl PluginGc

pub fn new( config: PluginGcConfig, plugin: &Arc<PersistentPlugin>, ) -> Result<PluginGc>

Start a new plugin garbage collector. Returns an error if the thread failed to spawn.

pub fn set_config(&self, config: PluginGcConfig)

Update the garbage collector config

pub fn flush(&self)

Ensure all GC messages have been processed

pub fn increment_locks(&self, amount: i64)

Increment the number of locks held by the plugin

pub fn decrement_locks(&self, amount: i64)

Decrement the number of locks held by the plugin

pub fn set_disabled(&self, disabled: bool)

Set whether the GC is disabled by explicit request from the plugin. This is separate from the enabled option in the config, and overrides that option.

pub fn stop_tracking(&self)

Tell the GC to stop tracking the plugin. The plugin will not be stopped. The GC cannot be reactivated after this request - a new one must be created instead.

pub fn exited(&self)

Tell the GC that the plugin exited so that it can remove it from the persistent plugin.

The reason the plugin tells the GC rather than just stopping itself via source is that it can’t guarantee that the plugin currently pointed to by source is itself, but if the GC is still running, it hasn’t received .stop_tracking() yet, which means it should be the right plugin.

Trait Implementations

impl Clone for PluginGc

fn clone(&self) -> PluginGc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginGc

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

Formats the value using the given formatter.