Add comments to the implementation

waldemarnt · waldemarnt · commit 2c0c18e2005c · 2019-07-29T21:30:31.000+10:00
diff --git a/index.js b/index.js
@@ -7,6 +7,7 @@ const { createLightship } = require('lightship');
  * https://nodejs.org/api/cluster.html
  */
 const cluster = require('cluster');
+//Get the number of CPUs available
 const CPUs = require('os').cpus().length;
 
 /**
@@ -15,6 +16,10 @@ const CPUs = require('os').cpus().length;
  */
 const ls = createLightship();
 
+/**
+ * If the cluster module is avaible
+ * and the process is the master
+ */
 if(config.get('App.cluster.enabled') && cluster.isMaster) {
   log.info(`Master ${process.pid} is running`);
 
diff --git a/src/routes/threads.js b/src/routes/threads.js
@@ -27,7 +27,7 @@ router.get('/fibonacciThreadedShared', async (req, res) => {
    * Uses shared SharedArrayBuffer to share data with the workers
    */
   const sharedUint8Array = new Uint8Array(new SharedArrayBuffer(4));
-  for(let i= 0; i< 4; i++) {
+  for (let i = 0; i < 4; i++) {
     runFibonacciShared({ iterations: 1000, position: i, arr: sharedUint8Array }).then(result => console.log(result));
   }
   res.send('processing');
diff --git a/src/workers/fibonacciWorker.js b/src/workers/fibonacciWorker.js
@@ -12,6 +12,9 @@ const runFibonacci = workerData => {
   });
 };
 
+/**
+ * If it's not the main thread it's one of the Worker threads
+ */
 if (!isMainThread) {
   const result = fb.iterate(workerData.iterations);
   parentPort.postMessage(result);
diff --git a/src/workers/fibonacciWorkerPool.js b/src/workers/fibonacciWorkerPool.js
@@ -18,6 +18,9 @@ const runFibonacci = workerData => {
   });
 };
 
+/**
+ * If it's not the main thread it's one of the Worker threads
+ */
 if (!isMainThread) {
   const result = fb.iterate(workerData.iterations);
   parentPort.postMessage(result);
diff --git a/src/workers/fibonacciWorkerShared.js b/src/workers/fibonacciWorkerShared.js
@@ -12,6 +12,9 @@ const runFibonacci = workerData => {
   });
 };
 
+/**
+ * If it's not the main thread it's one of the Worker threads
+ */
 if (!isMainThread) {
   const sharedArray = workerData.arr;
   const result = fb.iterate(workerData.iterations);

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ router.get('/fibonacciThreadedShared', async (req, res) => {`
`27`	`27`	`* Uses shared SharedArrayBuffer to share data with the workers`
`28`	`28`	`*/`
`29`	`29`	`const sharedUint8Array = new Uint8Array(new SharedArrayBuffer(4));`
`30`		`- for(let i= 0; i< 4; i++) {`
	`30`	`+ for (let i = 0; i < 4; i++) {`
`31`	`31`	`runFibonacciShared({ iterations: 1000, position: i, arr: sharedUint8Array }).then(result => console.log(result));`
`32`	`32`	`}`
`33`	`33`	`res.send('processing');`