Mishka Installer v0.0.4-beta.1

View Source MishkaInstaller.PluginStateDynamicSupervisor (Mishka Installer v0.0.4-beta.1)

This module supervises the states created during the registration of each plugin.

module-communication-process-of-this-module

 Module communication process of this module 

       +------------------------------------------------+
       |                                                |
       |                                                |
+------+  MishkaInstaller.PluginStateDynamicSupervisor  |
|      |                                                |
|      |                                                |
|      +--------------------------------------+----^----+
|                                             |    |
|                                             |    |
|                                             |    |
|      +--------------------------+           |    |
|      |                          |           |    |
+------>  PluginStateRegistry     |           |    |
       |                          |           |    |
       +--------^-----------------+           |    |
                |                             |    |
                |                             |    |
                |                             |    |
                |                             |    |
                |        +--------------------v----+-----+
                |        |                               |
                |        |  MishkaInstaller.PluginState  |
                +--------+                               |
                         +--------------------+----------+
                                              |
                                              |
                                              |
                                              |
          +----------------------------+      |
          |                            |      |
          | MishkaInstaller.PluginETS  <------+
          |                            |
          +----------------------------+

Link to this section Summary

Functions

get_plugin_pid(module_name)

Get PID based on the name of a plugin from PluginStateRegistry Registry.

running_imports()

Show all PIDs of PluginStateDynamicSupervisor module from PluginStateRegistry Registry.

running_imports(event_name)

Show all PIDs of PluginStateDynamicSupervisor module based on a specific event from PluginStateRegistry Registry.

start_job(args)

Start supervising plugin States.

terminate_childeren()

You are able to terminate all children that this module is responsible for supervising with the assistance of this function.

Link to this section Functions

Link to this function

get_plugin_pid(module_name)

View Source 
@spec get_plugin_pid(String.t()) ::
  {:error, :get_plugin_pid} | {:ok, :get_plugin_pid, pid()}

Get PID based on the name of a plugin from PluginStateRegistry Registry.

examples

 Examples 

MishkaInstaller.PluginStateDynamicSupervisor.get_plugin_pid("Plugin.TestName")
Link to this function

running_imports()

View Source

Show all PIDs of PluginStateDynamicSupervisor module from PluginStateRegistry Registry.

examples

 Examples 

MishkaInstaller.PluginStateDynamicSupervisor.running_imports()
Link to this function

running_imports(event_name)

View Source

Show all PIDs of PluginStateDynamicSupervisor module based on a specific event from PluginStateRegistry Registry.

examples

 Examples 

MishkaInstaller.PluginStateDynamicSupervisor.running_imports("event_test_name")
Link to this function

start_job(args)

View Source 
@spec start_job(%{id: String.t(), type: String.t(), parent_pid: any()}) ::
  :ignore | {:error, any()} | {:ok, :add | :edit, pid()}

Start supervising plugin States.

Link to this function

terminate_childeren()

View Source

You are able to terminate all children that this module is responsible for supervising with the assistance of this function.

examples

 Examples 

MishkaInstaller.PluginStateDynamicSupervisor.terminate_childeren()