registry

Documentation

Index

• Variables
• func RegisterResolver(r Registry, opts ...ResolverOption)
• type DeregisterOption
  • func DeregisterContext(ctx context.Context) DeregisterOption
• type DeregisterOptions
• type Event
• type EventType
  • func (t EventType) String() string
• type GetOption
  • func GetContext(ctx context.Context) GetOption
• type GetOptions
• type ListOption
  • func ListContext(ctx context.Context) ListOption
• type ListOptions
• type Node
• type Option
  • func Addrs(addrs ...string) Option
  • func Auth(username, password string) Option
  • func Timeout(t time.Duration) Option
• type Options
• type RegisterOption
  • func RegisterContext(ctx context.Context) RegisterOption
  • func RegisterTTL(t time.Duration) RegisterOption
• type RegisterOptions
• type Registry
  • func NewRegistry(opts ...Option) Registry
• type ResolverOption
  • func ResolverScheme(scheme string) ResolverOption
  • func ResolverService(service string) ResolverOption
• type ResolverOptions
• type Result
• type Service
• type WatchOption
  • func WatchService(name string) WatchOption
• type WatchOptions
• type Watcher

Variables

var (
	DefaultScheme  = "etcd"
	DefaultTimeOut = time.Second * 5
)

var (
	DefaultRegistry = NewRegistry()
	// Not found error when GetService is called
	ErrNotFound = errors.New("service not found")
)

Functions

func RegisterResolver

func RegisterResolver(r Registry, opts ...ResolverOption)

Types

type DeregisterOption

type DeregisterOption func(*DeregisterOptions)

func DeregisterContext

func DeregisterContext(ctx context.Context) DeregisterOption

type DeregisterOptions

type DeregisterOptions struct {
	Context context.Context
}

type Event

type Event struct {
	// Id is registry id
	Id string
	// Type defines type of event
	Type EventType
	// Timestamp is event timestamp
	Timestamp time.Time
	// Service is registry service
	Service *Service
}

Event is registry event

type EventType

type EventType int

EventType defines registry event type

const (
	// Create is emitted when a new service is registered
	Create EventType = iota
	// Delete is emitted when an existing service is deregsitered
	Delete
	// Update is emitted when an existing servicec is updated
	Update
)

func (EventType) String

func (t EventType) String() string

String returns human readable event type

type GetOption

type GetOption func(*GetOptions)

func GetContext

func GetContext(ctx context.Context) GetOption

type GetOptions

type GetOptions struct {
	Context context.Context
}

type ListOption

type ListOption func(*ListOptions)

func ListContext

func ListContext(ctx context.Context) ListOption

type ListOptions

type ListOptions struct {
	Context context.Context
}

type Node

type Node struct {
	Id       string            `json:"id"`
	Address  string            `json:"address"`
	Metadata map[string]string `json:"metadata"`
}

type Option

type Option func(*Options)

func Addrs

func Addrs(addrs ...string) Option

func Auth

func Auth(username, password string) Option

Auth allows you to specify username/password

func Timeout

func Timeout(t time.Duration) Option

type Options

type Options struct {
	Addrs   []string
	Timeout time.Duration
	Context context.Context
}

type RegisterOption

type RegisterOption func(*RegisterOptions)

func RegisterContext

func RegisterContext(ctx context.Context) RegisterOption

func RegisterTTL

func RegisterTTL(t time.Duration) RegisterOption

type RegisterOptions

type RegisterOptions struct {
	TTL     time.Duration
	Context context.Context
}

type Registry

type Registry interface {
	Init(...Option) error
	Options() Options
	Register(*Service, ...RegisterOption) error
	Deregister(*Service, ...DeregisterOption) error
	GetService(string, ...GetOption) ([]*Service, error)
	ListServices(...ListOption) ([]*Service, error)
	Watch(...WatchOption) (Watcher, error)
	String() string
}

func NewRegistry

func NewRegistry(opts ...Option) Registry

type ResolverOption

type ResolverOption func(*ResolverOptions)

func ResolverScheme

func ResolverScheme(scheme string) ResolverOption

func ResolverService

func ResolverService(service string) ResolverOption

type ResolverOptions

type ResolverOptions struct {
	Scheme  string
	Service string
	TimeOut time.Duration
}

type Result

type Result struct {
	Action  string
	Service *Service
}

Result is returned by a call to Next on the watcher. Actions can be create, update, delete

type Service

type Service struct {
	Name     string            `json:"name"`
	Version  string            `json:"version"`
	Metadata map[string]string `json:"metadata"`
	Nodes    []*Node           `json:"nodes"`
}

type WatchOption

type WatchOption func(*WatchOptions)

func WatchService

func WatchService(name string) WatchOption

Watch a service

type WatchOptions

type WatchOptions struct {
	// Specify a service to watch
	// If blank, the watch is for all services
	Service string
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

type Watcher

type Watcher interface {
	// Next is a blocking call
	Next() (*Result, error)
	Stop()
}

Watcher is an interface that returns updates about services within the registry.