Document what the mutexes are protecting

This commit is contained in:
Mark Haines 2017-06-28 14:32:59 +01:00
parent 0ba35df6b8
commit 903a9d5a19
2 changed files with 8 additions and 5 deletions

View file

@ -28,10 +28,12 @@ import (
// ensures that only one request is in flight to a given destination // ensures that only one request is in flight to a given destination
// at a time. // at a time.
type destinationQueue struct { type destinationQueue struct {
runningMutex sync.Mutex
client *gomatrixserverlib.FederationClient client *gomatrixserverlib.FederationClient
origin gomatrixserverlib.ServerName origin gomatrixserverlib.ServerName
destination gomatrixserverlib.ServerName destination gomatrixserverlib.ServerName
// The running mutex protects running, sentCounter, lastTransactionIDs and
// pendingEvents.
runningMutex sync.Mutex
running bool running bool
sentCounter int sentCounter int
lastTransactionIDs []gomatrixserverlib.TransactionID lastTransactionIDs []gomatrixserverlib.TransactionID

View file

@ -27,6 +27,7 @@ import (
type OutgoingQueues struct { type OutgoingQueues struct {
origin gomatrixserverlib.ServerName origin gomatrixserverlib.ServerName
client *gomatrixserverlib.FederationClient client *gomatrixserverlib.FederationClient
// The queuesMutex protects queues
queuesMutex sync.Mutex queuesMutex sync.Mutex
queues map[gomatrixserverlib.ServerName]*destinationQueue queues map[gomatrixserverlib.ServerName]*destinationQueue
} }