ducky/subscriptions
2015-10-04
Parent:1ff031bebf9e
ducky/subscriptions/memstore.go
Document our client to make golint happy. Take care of all the documentation warnings in the client subpackage, which means golint now returns successfully.
| paddy@0 | 1 package subscriptions |
| paddy@0 | 2 |
| paddy@0 | 3 import ( |
| paddy@0 | 4 "sync" |
| paddy@0 | 5 ) |
| paddy@0 | 6 |
| paddy@0 | 7 // Memstore is an in-memory version of our datastores, useful |
| paddy@0 | 8 // for testing. It should not be used in production. |
| paddy@0 | 9 type Memstore struct { |
| paddy@0 | 10 subscriptions map[string]Subscription |
| paddy@0 | 11 subscriptionLock sync.RWMutex |
| paddy@0 | 12 } |
| paddy@0 | 13 |
| paddy@0 | 14 // NewMemstore returns a pointer to a Memstore object, ready |
| paddy@0 | 15 // to be used as a datastore. |
| paddy@0 | 16 func NewMemstore() *Memstore { |
| paddy@0 | 17 return &Memstore{ |
| paddy@0 | 18 subscriptions: map[string]Subscription{}, |
| paddy@0 | 19 } |
| paddy@0 | 20 } |
| paddy@0 | 21 |
| paddy@13 | 22 // Reset empties all the data from the Memstore. It should only |
| paddy@13 | 23 // be used in tests. |
| paddy@3 | 24 func (m *Memstore) Reset() error { |
| paddy@0 | 25 m.subscriptionLock.Lock() |
| paddy@0 | 26 defer m.subscriptionLock.Unlock() |
| paddy@0 | 27 |
| paddy@0 | 28 m.subscriptions = map[string]Subscription{} |
| paddy@0 | 29 return nil |
| paddy@0 | 30 } |