Documentation:Aracne atoms - Revision history

Admin at 16:50, 22 July 2009

2009-07-22T16:50:56Z

Admin at 16:49, 22 July 2009

2009-07-22T16:49:35Z

Admin at 16:44, 22 July 2009

2009-07-22T16:44:44Z

Admin at 18:08, 9 June 2009

2009-06-09T18:08:41Z

Admin at 15:01, 8 June 2009

2009-06-08T15:01:30Z

Admin at 14:12, 3 June 2009

2009-06-03T14:12:22Z

Jlblanco: /* Hardware Platform */

2009-05-25T07:13:04Z

‎Hardware Platform

Jlblanco: /* Miscellaneous */

2009-05-25T07:12:40Z

‎Miscellaneous

Jlblanco: /* Error Discovering */

2009-05-25T07:09:53Z

‎Error Discovering

Jlblanco: /* Timing */

2009-05-25T07:09:23Z

‎Timing

@@ Line 39: / Line 39: @@
 * Module variable -id- (not suitable for filling at hand): the name of the variable that holds the module of the server, as a C++ identifier.
 * Service parameters -list-: the list of parameters passed (either variables or values),separated by commas. It has as many members as input plus output parameters of the service being called, and they should be in the same order (firstly the input parameters, then the output ones).
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it must do that through one of its output parameters, defined in its public interface).
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it will do that through one of its output parameters, defined in its public interface).
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.
@@ Line 80: / Line 80: @@
 	(Analogously for the rest of parameters)
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if no error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it must do that through one of its output parameters, defined in its public interface).
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if no error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it will do that through one of its output parameters, defined in its public interface).
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.

@@ Line 39: / Line 39: @@
 * Module variable -id- (not suitable for filling at hand): the name of the variable that holds the module of the server, as a C++ identifier.
 * Service parameters -list-: the list of parameters passed (either variables or values),separated by commas. It has as many members as input plus output parameters of the service being called, and they should be in the same order (firstly the input parameters, then the output ones).
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if error.
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it must do that through one of its output parameters, defined in its public interface).
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.
 * Response seconds variable -long- (optional): a C++ variable already existing to hold the seconds part of the timestamp set by the target of the service request when its logic is finished. Notice that this time is valid only if the requester and the requested are running in the same computer.
@@ Line 80: / Line 80: @@
 	(Analogously for the rest of parameters)
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if no error.
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if no error. NOTE: do not confuse this variable with any of the ones that may appear in the "Service parameters -list-" field. The "Error variable -bool-" is not visible in the called service, and its value is filled in automatically by the communication platform (in other words: it will not return any indication set by the called service; if that service needs to return some error indication, it must do that through one of its output parameters, defined in its public interface).
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.

@@ Line 38: / Line 38: @@
 * Service method -id- (not suitable for filling at hand): the name of the method implemented for serving the service, as a C++ identifier.
 * Module variable -id- (not suitable for filling at hand): the name of the variable that holds the module of the server, as a C++ identifier.
-* Service parameters -list-: the list of parameters passed (either variables or values),separated by commas.
+* Service parameters -list-: the list of parameters passed (either variables or values),separated by commas. It has as many members as input plus output parameters of the service being called, and they should be in the same order (firstly the input parameters, then the output ones).
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the request: true if error.
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if error.
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.
@@ Line 80: / Line 80: @@
 	(Analogously for the rest of parameters)
-* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the request: true if no error.
+* Error variable -bool-: the name of a C++ variable already existing for receiving indication of error during the communication of the request: true if no error.
 * Quickest -float-: minimum time in seconds that the service should last in returning a value.
 * Slowest -float-: maximum time in seconds that the service should last in returning a value.

@@ Line 493: / Line 493: @@
 * Seconds -long-:  a number indicating the seconds to block. The total time to block is given by the sum of this value and the next parameter.
 * Microseconds -long-: a number of microseconds to add to the previous parameter.
-Wait error variable -bool-: the name of a C++ variable that will hold an indication of any error during the blocking: true if error.
+Wait error variable -bool-: the name of a C++ variable that will hold an indication of any error during the blocking: false if error.
 '''SUPPORTED BY WIZARD'''

@@ Line 224: / Line 224: @@
 Quantity -unsigned-: the number of critical zones to create. They will be identified in the module by their index (from 0 to this number minus 1).
-Result -bool-: the name of a C++ variable already existing for receiving indication of error during the creation: true if error.
+Result -bool-: the name of a C++ variable already existing for receiving indication of error during the creation: false if error.
 '''SUPPORTED BY WIZARD'''
@@ Line 273: / Line 273: @@
 Zone index -unsigned-:  a number indicating the index of the critical zone into the set of critical zones created for the module.
-Result -bool-: the name of a C++ variable already existing for receiving indication of error during the entering: true if error.
+Result -bool-: the name of a C++ variable already existing for receiving indication of error during the entering: false if error.
 '''SUPPORTED BY WIZARD'''
@@ Line 298: / Line 298: @@
 Zone index -unsigned-:  a number indicating the index of the critical zone into the set of critical zones created for the module.
-Result -bool-: the name of a C++ variable already existing for receiving indication of error during the leaving: true if error.
+Result -bool-: the name of a C++ variable already existing for receiving indication of error during the leaving: false if error.
 '''SUPPORTED BY WIZARD'''

@@ Line 570: / Line 570: @@
 '''PARAMETERS'''
-* Seconds1 -long-:  the seconds part of the first time measurement.
+* Seconds1 -long-:  the seconds part of the second time measurement.
-* Microseconds1 -long-: the microseconds part of the first time measurement.
+* Microseconds1 -long-: the microseconds part of the second time measurement.
-* Seconds2 -long-:  the seconds part of the second time measurement.
+* Seconds2 -long-:  the seconds part of the first time measurement.
-* Microseconds2 -long-: the microseconds part of the second time measurement.
+* Microseconds2 -long-: the microseconds part of the first time measurement.
 * Seconds variable -long-:  a C++ variable already existing that will hold the seconds part of the time given by (second time - first time).
 * Microseconds variable  -long-: a C++ variable already existing that will hold the microseconds part of the time given by (second time - first time).

@@ Line 613: / Line 613: @@
 = Hardware Platform =
+None defined yet.
 = Miscellaneous =

← Older revision		Revision as of 07:12, 25 May 2009
Line 618:		Line 618:

	= Miscellaneous =		= Miscellaneous =
		+
		+
		+	=== check-disconnection ===
		+
		+	This atom checks if the module is currently being shut down. It is not necessary to protect all the body of the monitor+permanent services with this check, since they are already protected in that way (they finish their execution automatically if at their beginning they find the module is shutting down).
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All areas.
		+
		+	'''PARAMETERS'''
		+
		+	* Check variable -bool-: a C++ variable already existing for holding the result of the checking: true if module currently shutting down.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	shutdown-module.
		+
		+
		+
		+	=== return-server-routine ===
		+
		+	This atom returns from the logic being executed.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* Regular Services.
		+	* Event Handlers.
		+	* Notification Handlers.
		+
		+	'''PARAMETERS'''
		+
		+	<None>.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	shutdown-module.
		+
		+
		+
		+
		+	=== shutdown-module ===
		+
		+	This atom shuts down the module. However, the module is not immediately shut down since other services and threads must be terminated in a graceful fashion. If the shutdown atom returns "true", the logic where the shutdown is done should terminate with a "terminateservice" atom.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* Regular Services.
		+	* Event Handlers.
		+	* Notification Handlers.
		+	* Auxiliary Logic
		+
		+	'''PARAMETERS'''
		+
		+	* Result variable -bool-: a C++ variable already existing to hold the result of shutting down: true if no error (otherwise, no shutdown is done).
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	check-disconnection, terminateservice
		+
		+
		+
		+	=== disable-menu ===
		+
		+	This atom disables the main menu shown by the module for basic control of its operation, leaving available the keyboard input from the user.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All areas.
		+
		+	'''PARAMETERS'''
		+
		+	* Result variable -bool-: a C++ variable already existing to hold the result of disabling the menu: true if no error.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	enable-menu.
		+
		+
		+
		+
		+	=== enable-menu ===
		+
		+	This atom enables the main menu shown by the module for basic control of its operation, avoiding to use (by the logics of the module) the keyboard input from the user.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All areas.
		+
		+	'''PARAMETERS'''
		+
		+	Result variable -bool-: a C++ variable already existing to hold the result of disabling the menu: true if no error.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	disable-menu.
		+
		+
		+
		+	=== read-commandlineargument ===
		+
		+	This atom reads a command line argument passed to the executable file of the module. Arguments are assumed to have two parts separated by a space. The first part is the name of the argument and begins with "-". The second part is the value of the argument. For example: module_executable -ArgumentName <value>
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* Startup logic.
		+
		+	'''PARAMETERS'''
		+
		+	* Argument name -double-quoted string-: a double-quoted string (or variable that holds a char *) with the name of the argument.
		+	* Argument value variable -char *-: a C++ variable already existing that will be set to the address of the argument value, if any. That value must not be changed.
		+	* Exists variable -bool-: a C++ variable already existing that will hold the existence of the given argument: true if the argument was found.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	None.

← Older revision		Revision as of 07:09, 25 May 2009
Line 589:		Line 589:
	== Error Discovering ==		== Error Discovering ==

		+	=== user-log ===

		+	This atom issues a log to the time-logs of the module, for future off-line consulting through the BABEL Debugger. The text given in the atom will be automatically accompanied by a timestamp.

		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All logics.
		+
		+	'''PARAMETERS'''
		+
		+	* Log text -char -: a double-quoted string (or variable that holds a char ) with the text of the log.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	None.

	= Hardware Platform =		= Hardware Platform =

← Older revision		Revision as of 07:09, 25 May 2009
Line 479:		Line 479:
	== Timing ==		== Timing ==

		+	=== rt-suspend ===

		+	The logic that uses this atom is blocked until a given time passes.

		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All logics.
		+
		+	'''PARAMETERS'''
		+
		+	* Seconds -long-: a number indicating the seconds to block. The total time to block is given by the sum of this value and the next parameter.
		+	* Microseconds -long-: a number of microseconds to add to the previous parameter.
		+	Wait error variable -bool-: the name of a C++ variable that will hold an indication of any error during the blocking: true if error.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	get-currenttime.
		+
		+
		+
		+
		+	=== get-timestamp ===
		+
		+	This atom returns the time when the current logic was requested by its requester (for example, if the logic is a service, it will return the time when the requester of the service issued its request). Notice that this time is not valid if the requester and the requested are running in different computers.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* Regular Services.
		+	* Event Handlers.
		+	* Notification Handlers.
		+
		+	'''PARAMETERS'''
		+
		+	* Seconds -long-: a C++ variable already existing that will hold the seconds part of the time.
		+	* Microseconds -long-: a C++ variable already existing that will hold the microseconds part of the time.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	get-currenttime.
		+
		+
		+
		+	=== get-currenttime ===
		+
		+	This atom returns the current time.
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All logics.
		+
		+	'''PARAMETERS'''
		+
		+	* Seconds -long-: a C++ variable already existing that will hold the seconds part of the time.
		+	* Microseconds -long-: a C++ variable already existing that will hold the microseconds part of the time.
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	difftimes.
		+
		+
		+
		+	=== difftimes ===
		+
		+	This atom returns the difference between two given times (variable=time1-time2).
		+
		+	'''AVAILABILITY'''
		+
		+	Available in:
		+
		+	* All logics.
		+
		+	'''PARAMETERS'''
		+
		+	* Seconds1 -long-: the seconds part of the first time measurement.
		+	* Microseconds1 -long-: the microseconds part of the first time measurement.
		+	* Seconds2 -long-: the seconds part of the second time measurement.
		+	* Microseconds2 -long-: the microseconds part of the second time measurement.
		+	* Seconds variable -long-: a C++ variable already existing that will hold the seconds part of the time given by (second time - first time).
		+	* Microseconds variable -long-: a C++ variable already existing that will hold the microseconds part of the time given by (second time - first time).
		+
		+	'''SUPPORTED BY WIZARD'''
		+
		+	No.
		+
		+	'''SEE ALSO'''
		+
		+	get-currenttime.

	= Fault-Tolerance Platform =		= Fault-Tolerance Platform =