plugin

README

KeyVal plugin

KeyVal plugin defines a skeleton to access a key-value datastore. A particular datastore plugin uses this skeleton.

API

Implements the interface:

• KvPlugin

Documentation

Overview

Package plugin contains a keyval plugin skeleton used in various key-value data store clients (e.g. etcdv3/plugin_impl.go, redis/plugin_impl.go).

Index

• type Connection
• type Skeleton
  • func NewSkeleton(name string, serviceLabel servicelabel.ReaderAPI, connection Connection) *Skeleton
  • func (plugin *Skeleton) AfterInit() (err error)
  • func (plugin *Skeleton) Close() error
  • func (plugin *Skeleton) Init() (err error)
  • func (plugin *Skeleton) NewBroker(keyPrefix string) keyval.ProtoBroker
  • func (plugin *Skeleton) NewWatcher(keyPrefix string) keyval.ProtoWatcher

Types

type Connection

type Connection interface {
	keyval.CoreBrokerWatcher
}

Connection defines an access to a particular key-value data store implementation.

type Skeleton

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

Skeleton of a KV plugin is a generic part of KV plugin.

func NewSkeleton

func NewSkeleton(name string, serviceLabel servicelabel.ReaderAPI,
	connection Connection) *Skeleton

NewSkeleton creates a new instance of the Skeleton with the given connector. The connection is established in AfterInit phase.

func (*Skeleton) AfterInit

func (plugin *Skeleton) AfterInit() (err error)

AfterInit is called once all plugin have been initialized. The connection to datastore is established in this phase.

func (*Skeleton) Close

func (plugin *Skeleton) Close() error

Close cleans up the resources

func (*Skeleton) Init

func (plugin *Skeleton) Init() (err error)

Init is called on plugin startup

func (*Skeleton) NewBroker

func (plugin *Skeleton) NewBroker(keyPrefix string) keyval.ProtoBroker

NewBroker creates new instance of prefixed broker that provides API with arguments of type proto.Message

func (*Skeleton) NewWatcher

func (plugin *Skeleton) NewWatcher(keyPrefix string) keyval.ProtoWatcher

NewWatcher creates new instance of prefixed broker that provides API with arguments of type proto.Message