module: register disco info default entities.

yonggeshidai · May 20, 2018 · 55f2b62 · 55f2b62
1 parent de4dc99
commit 55f2b62
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/storage/badgerdb/badgerdb.go b/storage/badgerdb/badgerdb.go
@@ -31,12 +31,14 @@ type Config struct {
 	DataDir string `yaml:"data_dir"`
 }
 
+// Storage represents a BadgerDB storage sub system.
 type Storage struct {
 	db     *badger.DB
 	pool   *pool.BufferPool
 	doneCh chan chan bool
 }
 
+// New returns a new BadgerDB storage instance.
 func New(cfg *Config) *Storage {
 	b := &Storage{
 		pool:   pool.NewBufferPool(),
@@ -57,6 +59,7 @@ func New(cfg *Config) *Storage {
 	return b
 }
 
+// Shutdown shuts down BadgerDB storage sub system.
 func (b *Storage) Shutdown() {
 	ch := make(chan bool)
 	b.doneCh <- ch

diff --git a/storage/badgerdb/private.go b/storage/badgerdb/private.go
@@ -10,7 +10,8 @@ import (
 	"github.com/ortuman/jackal/xml"
 )
 
-// FetchPrivateXML retrieves from storage a private element.
+// InsertOrUpdatePrivateXML inserts a new private element into storage,
+// or updates it in case it's been previously inserted.
 func (b *Storage) InsertOrUpdatePrivateXML(privateXML []xml.XElement, namespace string, username string) error {
 	r := xml.NewElementName("r")
 	r.AppendElements(privateXML)
@@ -19,8 +20,7 @@ func (b *Storage) InsertOrUpdatePrivateXML(privateXML []xml.XElement, namespace
 	})
 }
 
-// InsertOrUpdatePrivateXML inserts a new private element into storage,
-// or updates it in case it's been previously inserted.
+// FetchPrivateXML retrieves from storage a private element.
 func (b *Storage) FetchPrivateXML(namespace string, username string) ([]xml.XElement, error) {
 	var r xml.Element
 	err := b.fetch(&r, b.privateStorageKey(username, namespace))

diff --git a/storage/memstorage/memstorage.go b/storage/memstorage/memstorage.go
@@ -18,6 +18,7 @@ import (
 // when mocked error is activated.
 var ErrMockedError = errors.New("storage mocked error")
 
+// Storage represents an in memory storage sub system.
 type Storage struct {
 	mockErr             uint32
 	mu                  sync.RWMutex
@@ -31,6 +32,7 @@ type Storage struct {
 	blockListItems      map[string][]model.BlockListItem
 }
 
+// New returns a new in memory storage instance.
 func New() *Storage {
 	return &Storage{
 		users:               make(map[string]*model.User),
@@ -44,13 +46,16 @@ func New() *Storage {
 	}
 }
 
+// Shutdown shuts down in memory storage sub system.
 func (m *Storage) Shutdown() {
 }
 
+// ActivateMockedError activates in memory mocked error.
 func (m *Storage) ActivateMockedError() {
 	atomic.StoreUint32(&m.mockErr, 1)
 }
 
+// DeactivateMockedError deactivates in memory mocked error.
 func (m *Storage) DeactivateMockedError() {
 	atomic.StoreUint32(&m.mockErr, 0)
 }

diff --git a/storage/memstorage/private.go b/storage/memstorage/private.go
@@ -7,7 +7,8 @@ package memstorage
 
 import "github.com/ortuman/jackal/xml"
 
-// FetchPrivateXML retrieves from storage a private element.
+// InsertOrUpdatePrivateXML inserts a new private element into storage,
+// or updates it in case it's been previously inserted.
 func (m *Storage) InsertOrUpdatePrivateXML(privateXML []xml.XElement, namespace string, username string) error {
 	return m.inWriteLock(func() error {
 		var elems []xml.XElement
@@ -19,8 +20,7 @@ func (m *Storage) InsertOrUpdatePrivateXML(privateXML []xml.XElement, namespace
 	})
 }
 
-// InsertOrUpdatePrivateXML inserts a new private element into storage,
-// or updates it in case it's been previously inserted.
+// FetchPrivateXML retrieves from storage a private element.
 func (m *Storage) FetchPrivateXML(namespace string, username string) ([]xml.XElement, error) {
 	var ret []xml.XElement
 	err := m.inReadLock(func() error {

diff --git a/storage/sql/sql.go b/storage/sql/sql.go
@@ -30,7 +30,7 @@ type rowsScanner interface {
 	Next() bool
 }
 
-// Config represents MySQL storage configuration.
+// Config represents SQL storage configuration.
 type Config struct {
 	Host     string `yaml:"host"`
 	User     string `yaml:"user"`
@@ -39,12 +39,14 @@ type Config struct {
 	PoolSize int    `yaml:"pool_size"`
 }
 
+// Storage represents a SQL storage sub system.
 type Storage struct {
 	db     *sql.DB
 	pool   *pool.BufferPool
 	doneCh chan chan bool
 }
 
+// New returns a SQL storage instance.
 func New(cfg *Config) *Storage {
 	var err error
 	s := &Storage{
@@ -72,6 +74,7 @@ func New(cfg *Config) *Storage {
 	return s
 }
 
+// NewMock returns a mocked SQL storage instance.
 func NewMock() (*Storage, sqlmock.Sqlmock) {
 	var err error
 	var sqlMock sqlmock.Sqlmock
@@ -85,6 +88,7 @@ func NewMock() (*Storage, sqlmock.Sqlmock) {
 	return s, sqlMock
 }
 
+// Shutdown shuts down SQL storage sub system.
 func (s *Storage) Shutdown() {
 	ch := make(chan bool)
 	s.doneCh <- ch