changeset 65:5dd87615e3e0

Documentation update for reminders module
author Lewin Bormann <lbo@spheniscida.de>
date Mon, 12 Dec 2016 20:22:14 +0100
parents 5f8092c3241c
children bf69962d10a5
files remind.go
diffstat 1 files changed, 7 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/remind.go	Mon Dec 12 20:20:19 2016 +0100
+++ b/remind.go	Mon Dec 12 20:22:14 2016 +0100
@@ -1,5 +1,5 @@
-// A background routine keeps polling the database for due reminders.
-// This is slightly inefficient but easier for now.
+// The reminder scheduler receives new reminders from the reminder handler via the REMINDERS_SCHEDULER
+// handle. It polls ever `inMemPollTime` for due reminders, fires them, and retries if they didn't succeed.
 package main
 
 import (
@@ -17,12 +17,11 @@
 )
 
 const (
-	expBackoffBase      = 4 // 1st retry after 4 seconds, 2nd retry after 16, 3rd retry after 64 seconds
-	inMemPollTime       = 1 * time.Second
-	maxAttempts         = 4
-	pollTime            = 30 * time.Second
-	reminderScheduleCap = 50
-	skipError           = 10 * time.Second
+	expBackoffBase      = 4                // 1st retry after 4 seconds, 2nd retry after 16, 3rd retry after 64 seconds
+	inMemPollTime       = 1 * time.Second  // how frequently to poll for due reminders
+	maxAttempts         = 4                // how often to retry delivering a reminder
+	reminderScheduleCap = 50               // Channel capacity of reminders channel
+	skipError           = 10 * time.Second // how long to wait after a DB error
 )
 
 type reminder struct {