module PlaceOS::Core::ProcessManager

Direct including types

Defined in:

placeos-core/process_manager.cr

Class Method Summary

Instance Method Summary

Class Method Detail

def self.path_to_key(path : String) : String #

Helper for extracting the driver key


[View source]

Instance Method Detail

def attach_debugger(module_id : String, socket : HTTP::WebSocket) #

[View source]
abstract def debug(module_id : String, &_on_message : DebugCallback) #

[View source]
abstract def driver_loaded?(driver_key : String) : Bool #

Check for the presence of a running driver on a ProcessManager


[View source]
abstract def driver_status(driver_key : String) : DriverStatus | Nil #

Generate a system status report


[View source]
abstract def execute(module_id : String, payload : String, user_id : String | Nil) #

Execute a driver method on a module


[View source]
abstract def ignore(module_id : String, &_on_message : DebugCallback) #

[View source]
abstract def ignore(module_id : String) : Array(DebugCallback) #

[View source]
abstract def kill(driver_key : String) #

[View source]
abstract def load(module_id : String, driver_key : String) #

[View source]
abstract def loaded_modules #

Count of distinct modules loaded on a ProcessManager


[View source]
abstract def module_loaded?(module_id : String) : Bool #

Check for the presence of a module on a ProcessManager


[View source]
abstract def on_exec(request : Request, response_callback : Request -> ) #

Handler for execute requests from a module


[View source]
def on_setting(id : String, setting_name : String, setting_value : YAML::Any) #

Handler for settings updates


[View source]
abstract def on_system_model(request : Request, response_callback : Request -> ) #

Handler for retrieving PlaceOS::Model::ControlSystems for logic modules


[View source]
abstract def run_count : Count #

Returns the count of ...

  • unique drivers running
  • module processes

[View source]
abstract def start(module_id : String, payload : String) #

[View source]
abstract def stop(module_id : String) #

[View source]
abstract def system_status : SystemStatus #

Generate a system status report


[View source]
abstract def unload(module_id : String) #

[View source]