From 044f726ae40abbdd1f634ca8e473ffcb31e5fdc5 Mon Sep 17 00:00:00 2001
From: Sarah Jamie Lewis <sarah@openprivacy.ca>
Date: Wed, 24 Mar 2021 13:09:07 -0700
Subject: [PATCH] Ammending Event Bus Api to remove Pointers

---
 event/eventQueue.go   | 10 +++++-----
 event/eventmanager.go |  3 ++-
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/event/eventQueue.go b/event/eventQueue.go
index f65ec77..94b40eb 100644
--- a/event/eventQueue.go
+++ b/event/eventQueue.go
@@ -19,7 +19,7 @@ type simpleQueue struct {
 // the event.Manager.
 type Queue interface {
 	Publish(event Event)
-	Next() *Event
+	Next() Event
 	Shutdown()
 	OutChan() <-chan Event
 	Len() int
@@ -52,9 +52,9 @@ func (sq *simpleQueue) Len() int {
 }
 
 // Next returns the next available event from the front of the queue
-func (sq *simpleQueue) Next() *Event {
+func (sq *simpleQueue) Next() Event {
 	event := <-sq.eventChannel
-	return &event
+	return event
 }
 
 // Shutdown closes our eventChannel
@@ -83,9 +83,9 @@ func (iq *queue) OutChan() <-chan Event {
 }
 
 // Out returns the next available event from the front of the queue
-func (iq *queue) Next() *Event {
+func (iq *queue) Next() Event {
 	event := <-iq.infChan.Out()
-	return &event
+	return event
 }
 
 func (iq *queue) Len() int {
diff --git a/event/eventmanager.go b/event/eventmanager.go
index 3ce621e..8ab9165 100644
--- a/event/eventmanager.go
+++ b/event/eventmanager.go
@@ -7,7 +7,8 @@ import (
 	"sync"
 )
 
-// Event is a structure which binds a given set of data to an Type
+// Events are the core struct passed around between various subsystems, they consist of a type which can be
+// filtered on, an event ID for tracing and a map of Fields to string values.
 type Event struct {
 	EventType Type
 	EventID   string