Javascript Engine - Revision history

Marian: /* Methods */

2024-09-19T08:35:02Z

‎Methods

Marian: /* Methods */

2024-09-10T09:37:53Z

‎Methods

Marian at 08:39, 10 September 2024

2024-09-10T08:39:49Z

Marian: /* Methods */

2024-09-10T08:37:03Z

‎Methods

Marian: /* Methods */

2024-09-10T08:34:04Z

‎Methods

Marian: /* Methods */

2024-09-10T08:21:45Z

‎Methods

Marian: /* Methods */

2024-09-09T16:08:14Z

‎Methods

Marian: /* Methods */

2024-09-09T16:07:42Z

‎Methods

Marian: /* Methods */

2024-09-09T15:54:31Z

‎Methods

Marian at 15:54, 9 September 2024

2024-09-09T15:54:24Z

@@ Line 336: / Line 336: @@
-* '''btoh(b64_str[,hex_sep[,hex_upcase]])'''
+* '''btoh(str[,hex_sep[,hex_upcase]])'''
 Convert binary (string) data to hexified string.<br>
 Parameters:<br>

@@ Line 172: / Line 172: @@
 Retrieve the debug enabled flag if no parameter is given.<br>
 Parameters:<br>
-'''on''': TRUE to enable debug output, FALSE to disable it<br>
+'''on''': True to enable debug output, false to disable it<br>
@@ Line 180: / Line 180: @@
 '''level''': Integer value to check<br>
 Return:<br>
-TRUE if the current debug level greater than or equal to '''level''', FALSE otherwise.<br>
+True if the current debug level greater than or equal to '''level''', false otherwise.<br>
@@ Line 205: / Line 205: @@
 Parameters:<br>
 '''name''': Configuration file name<br>
-'''user''': Optional. Set it to TRUE to build the path from user settings<br>
+'''user''': Optional. Set it to true to build the path from user settings<br>
 Return:<br>
 Path to requested file.<br>
@@ Line 229: / Line 229: @@
 '''id''': Timer id to remove<br>
 Return:<br>
-TRUE on success, FALSE if not found.<br>
+True on success, false if not found.<br>
@@ Line 240: / Line 240: @@
 '''callback_args''': Optional arguments to be passed to callback function<br>
 Return:<br>
-Event numeric id, FALSE on failure.<br>
+Event numeric id, false on failure.<br>
 Event type:<br/>
@@ Line 257: / Line 257: @@
 '''id''': Event id<br>
 Return:<br>
-TRUE on success, FALSE on failure (not found).<br>
+True on success, false on failure (not found).<br>
@@ Line 268: / Line 268: @@
 '''name''': Library of object name(s). Single name or comma separated list<br>
 Return:<br>
-TRUE on success, FALSE on failure (library/object) not given or not found. <br>
+True on success, false on failure (library/object) not given or not found. <br>
   // The following load objects defined in jsext module:
   loadLibrary("jsext");
@@ Line 412: / Line 412: @@
 # Dispatch an ''engine.init'' message
 # Call initialize function for each installed plugins
-# Return TRUE
+# Return True
 Plugin init:
 # Dispatch an ''engine.init'' message with ''plugin'' parameter set to requested plugin name
 # Call plugin's initialize function if is an installed one
-# Return TRUE if plugin is internal or ''engine.init'' message was handled, FALSE otherwise
+# Return true if plugin is internal or ''engine.init'' message was handled, false otherwise
@@ Line 426: / Line 426: @@
 '''gracefull''': Optional. Attempt to wait until no plugin is busy<br>
 Return:<br>
-TRUE if restart was initiated, FALSE if exiting or no supervisor or 'allow_abort' is disabled in javascript.conf.<br>
+True if restart was initiated, false if exiting or no supervisor or 'allow_abort' is disabled in javascript.conf.<br>
@@ Line 432: / Line 432: @@
 Check if engine is started at the time this method is called (engine.start message was sent).<br>
 Return:<br>
-TRUE if engine was started (all modules were loaded and initialized), FALSE if not.<br>
+True if engine was started (all modules were loaded and initialized), false if not.<br>

@@ Line 437: / Line 437: @@
 * '''exiting()'''
 Return:<br>
-TRUE if engine (application) is exiting exiting (return code was set, Yate is executing stop procedures), FALSE if not.<br>
+True if engine (application) is exiting exiting (return code was set, Yate is executing stop procedures), false if not.<br>
@@ Line 449: / Line 449: @@
 Durations:<br/>
 '''Engine.WallTime''': Duration from application start<br>
-'''Engine.UserTime''': Duration spent by application in user space<br>
+'''Engine.UserTime''': Time spent by application in user space<br>
-'''Engine.KernelTime''': Duration spent by application in kernel space<br>
+'''Engine.KernelTime''': Time spent by application in kernel space<br>
@@ Line 457: / Line 457: @@
 Parameters:<br/>
 '''name''': Plugin name<br/>
-Return: TRUE if loaded, false otherwise.<br/>
+Return: True if loaded, false otherwise.<br/>
 Example:

@@ Line 390: / Line 390: @@
 '''Engine.ScriptTypeDynamic''' Script was loaded using ''javascript load'' command<br/>
 '''Engine.ScriptTypeMsgHandler''' Script is running a singleton message handler context<br/>
-'''Engine.ScriptTypeEval''' Script is running was loaded using ''javascript eval'' command<br/>
+'''Engine.ScriptTypeEval''' Script is was loaded using ''javascript eval'' command<br/>
 '''Engine.ScriptTypeRoute''' Script is running a singleton routing context (see the ''routing'' option of javascript config) <br/>

@@ Line 18: / Line 18: @@
 Concatenate values. Put a space between them.<br>
 Does nothing if the resulting string is empty.<br>
-Debug level is handled if the first parameter is an integer value. Defaults to Engine.DebugNote otherwise.<br>
+Debug level is handled if the first parameter is an integer value and function is called with at least 2 parameters. Defaults to Engine.DebugNote otherwise.<br>
   // The following calls will produce the same debug message:
   Engine.debug(Engine.DebugNote,"test","out");

@@ Line 23: / Line 23: @@
   Engine.debug(8,"test out");
   Engine.debug("test" + " out");
@@ Line 55: / Line 40: @@
 * '''sleep(seconds)'''
 Sleep for a number of seconds.<br>
@@ Line 122: / Line 125: @@
 '''table''': Table to dump<br>
 '''hdrMap''': Header name mapping. Object with prop[header name in table]=value[new header display name]. Fields will be re-arranged as found in header mapping. New header display name may be empty if the list is only used to re-arrange fields<br>
-'''params''': Dump parameters parameters
+'''params''': Dump parameters
-* '''force_empty''': Boolean (default: false). Dump table with empty contents (no rows). Ignored if there are no header names
+* '''force_empty''': Boolean (default: false). Dump titles/values separator if empty contents (no rows). Ignored if there are no header names
 * '''all_headers''': Boolean (default: false). Add the rest of the headers not found in 'hdrMap'. Ignored if 'hdrpMap' is not given
 Return:<br>
 '''dump_t''' returns the string containing dumped data.<br>
   a = [{name1:"val11", name2:"val12"}, {name1:"val21", name3:"val23"}];
   a2 = [["name1","name2","name3"], ["val11","val12" ],["val21",undefined,"val23"]];

@@ Line 30: / Line 30: @@
 '''traceId''' Id to trace.<br/>
 All other parameters are the same as in ''debug()'' function.<br/>
-These functions behaves like ''debug()'' function. ''trace'' does nothing if ''traceId'' is empty.<br/>
+These functions behaves like ''debug()'' function. ''trace()'' does nothing if ''traceId'' is empty.<br/>
 When ''traceId'' is not empty a 'Trace:<traceId>' is added before debug contents.<br/>

← Older revision		Revision as of 16:07, 9 September 2024
Line 23:		Line 23:
	Engine.debug(8,"test out");		Engine.debug(8,"test out");
	Engine.debug("test" + " out");		Engine.debug("test" + " out");
		+
		+
		+	* '''trace(traceId,[level,][value1[,value2[, ...]]])'''
		+	* '''traceDebug(traceId,[level,][value1[,value2[, ...]]])'''
		+	Put a debug message in console / log adding some extra string.<br>
		+	'''traceId''' Id to trace.<br/>
		+	All other parameters are the same as in ''debug()'' function.<br/>
		+	These functions behaves like ''debug()'' function. ''trace'' does nothing if ''traceId'' is empty.<br/>
		+	When ''traceId'' is not empty a 'Trace:<traceId>' is added before debug contents.<br/>
		+
		+	Example:
		+	var traceId = "sime_id";
		+	Engine.traceDebug(traceId,Engine.DebugAll,"some string");
		+	// Same as
		+	Engine.debug(Engine.DebugAll,"Trace:" + traceId,"some string");

@@ Line 374: / Line 374: @@
-* '''init([plugin])'''
+* '''init([name])'''
 Initialize all or specified plugin.<br/>
 Parameters:<br/>
-'''plugin''': Plugin name. Initialize engine and all plugins if this parameter is not given, empty or it value is '*' or 'all'<br/>
+'''name''': Plugin name. Initialize engine and all plugins if this parameter is not given, empty or it value is '*' or 'all'<br/>
 All plugins (engine) init:
@@ Line 391: / Line 391: @@
-* '''restart([code [,gracefull]])'''
+* '''restart([code[,gracefull]])'''
 Stop and restart the engine and the entire program.<br>
 Parameters:<br>
@@ Line 422: / Line 422: @@
 '''Engine.UserTime''': Duration spent by application in user space<br>
 '''Engine.KernelTime''': Duration spent by application in kernel space<br>
@@ Line 459: / Line 490: @@
       "a"
   ]; // creationLine() returns this line
 == Properties ==