msWatchStorage

package
v0.0.0-...-0bff97c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 9, 2017 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var NewRedisStorage = func(config map[string]interface{}) (Storage, error) {
	dsn, ok := config["dsn"]
	if !ok {
		err := fmt.Errorf("the DSN configuration option is required for the Redis storage")
		return nil, err
	}

	sDSN := dsn.(string)

	client, err := redis.Dial("tcp", sDSN)
	if err != nil {
		err := fmt.Errorf("failed to connect to Redis: %s", err.Error())
		return nil, err
	}

	storage := Redis{
		dsn:    sDSN,
		client: client,
	}

	return storage, nil
}

NewRedisStorage implements the StorageFactory function type. It initiates a connection to the Redis database defined in the given configuration, and it returns the Storage engine object.

Functions

This section is empty.

Types

type Redis

type Redis struct {
	// contains filtered or unexported fields
}

Redis implements the Storage interface, allowing to use Redis as a Storage engine.

func (Redis) Create

func (storage Redis) Create(watchPointer *common.Watch) (*int, error)

Create implements Storage.Create(). It stores the given Watch object as a new value in the Redis Storage and it returns an automatically generated ID.

func (Redis) Get

func (storage Redis) Get(id int) (*common.Watch, error)

Get implements Storage.Get(). It retrieves from Storage and returns the Watch for the given ID.

func (Redis) Update

func (storage Redis) Update(watchID int, watchPointer *common.Watch) error

Update implements Storage.Update(). It stores the given Watch object as a value in the Redis Storage, overriding the existing value with the given ID.

type Storage

type Storage interface {
	Create(*common.Watch) (*int, error)
	Get(int) (*common.Watch, error)
	Update(int, *common.Watch) error
}

Storage is an interface that should be implemented by all Storage engines. It defines an API for storing and retrieving Watch objects.

func Create

func Create(config map[string]interface{}) (Storage, error)

Create creates and returns a Storage provider, given the configuration that includes configuration required by the provider.

type StorageFactory

type StorageFactory func(confing map[string]interface{}) (Storage, error)

StorageFactory is a function type that should be implemented by all Storage engine factories. It defines a function type that receives the required configuration as a map, and it returns the Storage engine object. The configuration should include the requested engine keyed "STORAGE_ENGINE" plus any configuration required by the engine itself.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL