Difference between revisions of "SHIPHarbour:DataTypes:ProgramState"

From Serious Documentation
Jump to: navigation, search
(Created page with "==Coming Soon== This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Suppor...")
 
 
Line 1: Line 1:
−
==Coming Soon==
+
== Description ==
−
This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Support].
+
<onlyinclude>Used as part of the [[SHIPHarbour:Data_Types:Program|Program]] type to describe the state of a program that can execute on a Serious module.</onlyinclude>
 +
 
 +
=== UNSET_PROGRAMSTATE ===
 +
Must not be used, indicates the field was not set properly.
 +
 
 +
=== INVALID_PROGRAMSTATE ===
 +
May be used internally to indicate an error when encountering an unexpected value.
 +
 
 +
----
 +
 
 +
=== BOOT ===
 +
Settable by the client, indicates the module should move to the start of a specific program.
  
−
Thank you for your patience.
+
=== UPDATE ===
 +
Settable by the client, indicates the module should get ready to update in a specific program.
  
−
[[Category:NoIndex]]
+
=== LAUNCH ===
−
[[Category:UnderConstruction]]
+
Settable by the client, indicates the module should perform the normal operation of a specific program.
  
−
== Description ==
+
=== HALT ===
−
<onlyinclude>Used as part of the [[SHIPHarbour:Data_Types:Program|Program]] type to describe the state of a program that can execute on a Serious module.</onlyinclude>
+
Settable by the client, indicates the module should stop executing the normal operation and wait indefinitely for further instruction.
 +
 
 +
----
 +
 
 +
=== BOOTING ===
 +
Reported by SHIPHarbour Master, indicates the module is at the start of a program.
 +
=== RUNNING ===
 +
Reported by SHIPHarbour Master, indicates the module is executing a program normally.
 +
=== HALTING ===
 +
Reported by SHIPHarbour Master, indicates the module is stopping execution of a program.
 +
=== WAITING ===
 +
Reported by SHIPHarbour Master, indicates the module is waiting for further instruction.
 +
=== UPDATING ===
 +
Reported by SHIPHarbour Master, indicates the module is ready to be updated.
 +
=== REBOOTING ===
 +
Reported by SHIPHarbour Master, indicates the module is about to reboot.

Latest revision as of 18:43, 31 July 2017

Description

Used as part of the Program type to describe the state of a program that can execute on a Serious module.

UNSET_PROGRAMSTATE

Must not be used, indicates the field was not set properly.

INVALID_PROGRAMSTATE

May be used internally to indicate an error when encountering an unexpected value.

BOOT

Settable by the client, indicates the module should move to the start of a specific program.

UPDATE

Settable by the client, indicates the module should get ready to update in a specific program.

LAUNCH

Settable by the client, indicates the module should perform the normal operation of a specific program.

HALT

Settable by the client, indicates the module should stop executing the normal operation and wait indefinitely for further instruction.

BOOTING

Reported by SHIPHarbour Master, indicates the module is at the start of a program.

RUNNING

Reported by SHIPHarbour Master, indicates the module is executing a program normally.

HALTING

Reported by SHIPHarbour Master, indicates the module is stopping execution of a program.

WAITING

Reported by SHIPHarbour Master, indicates the module is waiting for further instruction.

UPDATING

Reported by SHIPHarbour Master, indicates the module is ready to be updated.

REBOOTING

Reported by SHIPHarbour Master, indicates the module is about to reboot.

Retrieved from "https://techref.myserious.com/index.php?title=SHIPHarbour:DataTypes:ProgramState&oldid=7371"