Struct GCPluginInstance 

pub struct GCPluginInstance<T: GCPluginCallbackHandler>(Arc<GCPluginInstanceInner<T>>);

GCPluginInstance is a reference counted wrapper that holds the PluginRunningInstance, which contains the resources necessary for the plugin execution, and provides a safe way to interact with it.

This structure can be cloned and shared between threads.

Tuple Fields

0: Arc<GCPluginInstanceInner<T>>

Implementations

impl<T: GCPluginCallbackHandler> GCPluginInstance<T>

pub(crate) fn new( instance_name: &str, plugin_name: String, callback_handler: Box<T>, ) -> Self

Creates a new instance without starting the underlying plugin.

pub(crate) fn init( &self, config: GCPluginInstanceConfig<'_>, plugin_dll: PluginDLL, ) -> Result<(), GCPluginManagerError>

Starts the plugin instance.

This function should not be exposed to the rest of the application. Each instance should be initialized by the GCPluginManager instead. This function assumes that EVERY plugin instance name are unique!

Attempts to start an instance belonging to a different plugin DLL will result in an ErrorPluginMismatch.

pub fn is_running(&self) -> bool

Check if the plugin instance is running.

pub fn get_instance_name(&self) -> &str

Get the instance name

pub fn get_plugin_name(&self) -> &str

Get the plugin DLL name

pub fn get_plugin_info(&self) -> Option<GCPluginInfo>

Get the plugin info

This only returns the plugin info if the plugin instance is running. If the info is required even when instance is not running consider using the GCPlugin instead.

pub(crate) fn shutdown(&self) -> Result<(), GCPluginManagerError>

Shutdown the underlying plugin instance.

This function should be called only by the GCPlugin when the plugin is being stopped, and thus isn’t be exposed to the rest of the application.

Trait Implementations

impl<T> Clone for GCPluginInstance<T>

where T: GCPluginCallbackHandler,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: GCPluginCallbackHandler> Debug for GCPluginInstance<T>

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

Formats the value using the given formatter.

impl<T: GCPluginCallbackHandler + 'static> Deref for GCPluginInstance<T>

type Target = dyn GCDatapointSubscriber

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: GCPluginCallbackHandler + 'static> From<GCPluginInstance<T>> for Arc<dyn GCDatapointSubscriber>

fn from(val: GCPluginInstance<T>) -> Self

Converts to this type from the input type.