rasahub.plugin module

class rasahub.plugin.RasahubPlugin

Bases: object

Main class for a plugin.

add_target(classname)

Adds target to plugin.

Args:

classname: Classname of target plugin

end()

Function to close connections etc., to be implemented by plugin.

end_process()

Safely closes threads.

in_thread(main_queue, run_event)

Input message thread.

Args:

main_queue: Main message queue of Handler run_event: Thread run event

out_thread(outputqueue, main_queue, run_event)

Output message thread.

Args:

outputqueue: Output queue of plugin main_queue: Main message queue of Handler run_event: Thread run event

process_command(message, out_message)

Output message hook, to be implemented by plugin.

receive()

Receiving function, to be implemented by plugin.

send(messagedata)

Sending function, to be implemented by plugin.

set_name(pluginname)

Sets name of plugin.

Args:

pluginname: Name of the plugin

start(main_queue)

Starts sending and receiving threads.

Args:

main_queue: Main message queue of handler