moar documentation

backend/ssgrpc/ssgrpc.go

@@ -1,3 +1,6 @@
+/*
+Package ssgrpc provides a ss.MultihomeBackend interface that uses grpc with profobufs for synchronizing broadcasts and roomcasts between multiple Sacrificial Socket instances.
+*/
 package ssgrpc
 
 import (

backend/ssgrpc/token/token.go

@@ -1,13 +1,12 @@
+/*
+Package token is used by package ssgrpc for generating and validating HMAC-SHA256 tokens sent as "per RPC credentials".
+*/
 package token
 
 import (
 	"encoding/json"
 	"errors"
-	//"fmt"
 	"github.com/dvsekhvalnov/jose2go"
-	//"net/http"
-	//"strings"
-	//"sync"
 	"time"
 )
 

backend/ssmongo/ssmongo.go

@@ -1,3 +1,6 @@
+/*
+Package ssmongo provides a ss.MultihomeBackend interface that uses MongoDB for synchronizing broadcasts and roomcasts between multiple Sacrificial Socket instances.
+*/
 package ssmongo
 
 import (

examples/not-so-simple-examples/grpc-multihome/main.go

@@ -1,3 +1,6 @@
+/*
+A complex web app example that implements ssgrpc for synchronizing multiple Sacrificial Socket instances
+*/
 package main
 
 import (

examples/simple-examples/chat/main.go

@@ -1,3 +1,6 @@
+/*
+A simple web chat app example that does not implement any multihome backends.
+*/
 package main
 
 import (

log/log.go

@@ -1,3 +1,6 @@
+/*
+Package log is used all throughout Sacrificial Socket for logging info and error messages
+*/
 package log
 
 import (

tools/random.go

@@ -1,3 +1,6 @@
+/*
+Package tools is really just used during socket creation to generate random numbers for socket IDs.
+*/
 package tools
 
 import (