Persistence layer interface

internal/models/common.go

@@ -0,0 +1,3 @@
+package models
+
+type Id string

internal/models/queue.go

@@ -0,0 +1,33 @@
+package models
+
+import (
+	"time"
+)
+
+// This ID will be exposed to clients, and hence have to be properly random and unguessable.
+type QueueId Id
+
+type Queue struct {
+	// Unique ID for the queue. 
+	Id QueueId
+
+	// Name of the queue. The name is used in generating queue urls, for ex 
+	// https://simplq.me/j/<QueueName>. The storage layer guarantees sure that 
+	// there is only one queue by a given name.
+	QueueName string
+
+	// Set to true if the queue is temporarily not issuing tokens
+	bool IsPaused
+
+	// Set to true if the queue has been deleted
+	bool IsDeleted
+
+	// Tokens present in the queue.
+	Tokens []Token
+
+	// Creation time.
+	CreationTime time.Time
+
+	// Deletion time.
+	DeletionTime time.Time
+}

internal/models/token.go

@@ -0,0 +1,38 @@
+package models
+
+import (
+	"time"
+)
+
+// This ID will be exposed to clients, and hence have to be properly random and unguessable.
+type TokenId Id
+
+type Token struct {
+	// Unique ID for the token. 
+	Id TokenId
+
+	// Name of the token, typically name of the person to whom the token was
+	// issued.
+	Name string
+
+	// Contact Number
+	ContactNumber string
+
+	// Optional. Email ID if the queue collects email ID of users. 
+	EmailId string
+
+	// Set to true if the token has been deleted
+	bool IsDeleted
+
+	// Number of times the token was notified.
+	NotifiedCount uint32
+
+	// Timestamp when the token was last notified.
+	LastNotifiedTime time.Time
+
+	// Creation time.
+	CreationTime time.Time
+
+	// Deletion time.
+	DeletionTime time.Time
+}

internal/persistence/persistence.go

@@ -0,0 +1,25 @@
+package persistence
+
+import (
+	"github.com/SimplQ/simplQ-golang/internal/models"
+)
+
+type QueueStore interface {
+	// Create a new queue and return the queue ID.
+	CreateQueue(models.Queue) models.QueueId
+
+	// Read a queue by id.
+	ReadQueue(models.QueueId) models.Queue
+
+	// Set the queue status to new value.
+	UpdateQueueStatus(models.QueueId, models.QueueStatus)
+
+	// Add a new token to the queue.
+	AddTokenToQueue(models.QueueId, models.Token)
+
+	// Read token by id.
+	ReadToken(models.TokenId)
+
+	// Set token status to new value.
+	UpdateTokenStatus(models.TokenId, models.TokenStatus)
+}