From 529cc4844032e8644fd7e41f8251a6709bc16fbc Mon Sep 17 00:00:00 2001
From: postmannen <postmannen@gmail.com>
Date: Wed, 17 Feb 2021 16:58:51 +0100
Subject: [PATCH] naming, and comments

---
 incommmingBuffer.db | Bin 32768 -> 32768 bytes
 publisher.go        |  26 +++++++++++++++++---------
 2 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/incommmingBuffer.db b/incommmingBuffer.db
index 0c1eac2f8ddf49209f5c8f281dc94bd320d67c0f..1eba0851fd099970a5af3ac0f92fdb1eb003f47a 100644
GIT binary patch
delta 133
zcmZo@U}|V!n&2R?h5-sLmhBBuZF{g;(O?7rBmoD3)ll*D>(_U<CFMPVNGRwq%1zc)
z@MJWaT&`fn_XeoQ#IRb)(?!Y3#BlO{1qGnQ0|kE|X`m>_RZ^6is-UN*uM|7^p@Q+|
V9>o&A&Hwew1sIJsmpgRY0{~6cD4PHP

delta 133
zcmZo@U}|V!n&2R?i~$0?ww>2n|2j}?v!cNU{z(E30!yJ1E3>zqi};YN1d&kCVU(Y&
ztKi9KFu7d8itjB@k+Eg9lBbK3m9gdI{R#?<hLayC_yb7;MLF)AVg=nC1wB1|rP#?2
X6^u7`E0*wWGAI*ZG}v73&}k0<Bxol#

diff --git a/publisher.go b/publisher.go
index 7c451a1..0cf6433 100644
--- a/publisher.go
+++ b/publisher.go
@@ -139,13 +139,15 @@ func (s *server) printProcessesMap() {
 
 // handleNewOperatorMessages will handle all the new operator messages
 // given to the system, and route them to the correct subject queue.
+// It will also handle the process of spawning more worker processes
+// for publisher subjects if it does not exist.
 func (s *server) handleMessagesInRingbuffer() {
 	// Prepare and start a new ring buffer
 	const bufferSize int = 1000
 	rb := newringBuffer(bufferSize)
 	inCh := make(chan subjectAndMessage)
-	outCh := make(chan samDBValue)
-	rb.start(inCh, outCh)
+	ringBufferOutCh := make(chan samDBValue)
+	rb.start(inCh, ringBufferOutCh)
 
 	// Start reading new messages received on the incomming message
 	// pipe requested by operator, and fill them into the buffer.
@@ -162,7 +164,7 @@ func (s *server) handleMessagesInRingbuffer() {
 	// send if there are a specific subject for it, and no subject
 	// exist throw an error.
 	go func() {
-		for samTmp := range outCh {
+		for samTmp := range ringBufferOutCh {
 			sam := samTmp.Data
 			// Check if the format of the message is correct.
 			// TODO: Send a message to the error kernel here that
@@ -175,20 +177,25 @@ func (s *server) handleMessagesInRingbuffer() {
 				continue
 			}
 
+		redo:
 			// Adding a label here so we are able to redo the sending
 			// of the last message if a process with specified subject
 			// is not present. The process will then be created, and
 			// the code will loop back to the redo: label.
 
-		redo:
 			m := sam.Message
 			subjName := sam.Subject.name()
 			// DEBUG: fmt.Printf("** handleNewOperatorMessages: message: %v, ** subject: %#v\n", m, sam.Subject)
 			_, ok := s.processes[subjName]
+
+			// Are there already a process for that subject, put the
+			// message on that processes incomming message channel.
 			if ok {
 				log.Printf("info: found the specific subject: %v\n", subjName)
-				// Put the message on the correct process's messageCh
 				s.processes[subjName].subject.messageCh <- m
+
+				// If no process to handle the specific subject exist,
+				// the we create and spawn one.
 			} else {
 				// If a publisher do not exist for the given subject, create it, and
 				// by using the goto at the end redo the process for this specific message.
@@ -201,7 +208,8 @@ func (s *server) handleMessagesInRingbuffer() {
 
 				time.Sleep(time.Millisecond * 500)
 				s.printProcessesMap()
-				// Now when the process is spawned we jump back to the redo: label.
+				// Now when the process is spawned we jump back to the redo: label,
+				// and send the message to that new process.
 				goto redo
 			}
 		}
@@ -288,9 +296,9 @@ func (s *server) processPrepareNew(subject Subject, errCh chan errProcess, proce
 	return proc
 }
 
-// spawnProcess will spawn a new process. It will give the process
-// the next available ID, and also add the process to the processes
-// map.
+// processSpawnWorker will spawn a new process. It will give the
+// process the next available ID, and also add the process to the
+// processes map.
 func (s *server) processSpawnWorker(proc process) {
 	s.mu.Lock()
 	// We use the full name of the subject to identify a unique