spinn_front_end_common.utilities.notification_protocol package

Submodules

spinn_front_end_common.utilities.notification_protocol.notification_protocol module

class spinn_front_end_common.utilities.notification_protocol.notification_protocol.NotificationProtocol(socket_addresses, wait_for_read_confirmation)[source]

Bases: object

The protocol which hand shakes with external devices about the database and starting execution

close()[source]

Closes the thread pool

send_read_notification(database_path)[source]

sends notifications to all devices which have expressed an interest in when the database has been written

Parameters:database_path – the path to the database file
Return type:None
send_start_resume_notification()[source]

either waits till all sources have confirmed read the database and are configured, and/or just sends the start notification (when the system is executing)

Return type:None
send_stop_pause_notification()[source]

sends the pause / stop notifications when the script has either finished or paused

Return type:None
wait_for_confirmation()[source]

if asked to wait for confirmation, waits for all external systems to confirm that they are configured and have read the database

Return type:None

spinn_front_end_common.utilities.notification_protocol.socket_address module

class spinn_front_end_common.utilities.notification_protocol.socket_address.SocketAddress(notify_host_name, notify_port_no, listen_port)[source]

Bases: object

Data holder for a socket interface for notification protocol.

listen_port

The port to listen to for responses

notify_host_name

The notify host name

notify_port_no

The notify port no

Module contents