Cod Comments added

This commit is contained in:
Luis Fernando Molina committed 2021-07-06 09:33:45 +02:00
1 parent b48de42683
commit 7ec952d432
1 file changed
+9 -2
@@ -12,9 +12,16 @@ exports.newFoundationsGlobalsProcessVariables = function () {
/*
VARIABLES_BY_PROCESS_INDEX_MAP
At the Task Server, a Task run Procesess, potentially many of them, depending on definitions external to the
Task Server. Each process is independent from each other and have a set of process level variables that help
the process do its job. You can consider these variables as the process state. All the modules running inside
a process know the processIndex, and with that index they can get this Map that contains all the needed variables
of that represent the process state. It was implemented as a Map and not just an object with properties for no
particular reason.
What it is stored here depends very much on what the process is about and what it needs to do. Following
is a list of known properties of this object.
is a list of known keys of this map.
PROCESS_KEY This is the key used in events related to the Process
SESSION_KEY This is the key used in events related to the Session
@@ -32,7 +39,7 @@ exports.newFoundationsGlobalsProcessVariables = function () {
TRADING_PROCESSING_DAILY_FILES When in a trading process, this tell us if we are processing Daily Files or not.
FILE_PATH_ROOT Stores the prefix of the path of any data or log file.
WAIT_FOR_EXECUTION_FINISHED_EVENT This boolean flag tell us if the process waits for an event to continue.
UNEXPECTED_ERROR: When we encounter an error that will produce the Process to be stopped, we store the err object here so that is properties can be extracted for logging purposes.
UNEXPECTED_ERROR When we encounter an error that will produce the Process to be stopped, we store the err object here so that is properties can be extracted for logging purposes.
*/
return thisObject