consul

Documentation

Index

• type Catalog
• type CatalogServiceQuery
• type MockResolver
  • func (mr *MockResolver) RemoveCacheItem(function string)
  • func (mr *MockResolver) Resolve(function string) ([]string, error)
• type Resolver
  • func NewResolver(address string, logger hclog.Logger) *Resolver
  • func (sr *Resolver) RemoveCacheItem(function string)
  • func (sr *Resolver) Resolve(function string) ([]string, error)
• type ServiceResolver
• type Watcher
• type WrappedWatcher
  • func (ww *WrappedWatcher) ItterateDataCh(f itterateFunc)

Types

type Catalog

type Catalog interface {
	Service(service, tag string, q *api.QueryOptions) ([]*api.CatalogService, *api.QueryMeta, error)
}

Catalog defines methods for Consul's service catalog

type CatalogServiceQuery

type CatalogServiceQuery interface {
	Fetch(clients *dependency.ClientSet, opts *dependency.QueryOptions) (interface{}, *dependency.ResponseMetadata, error)
	CanShare() bool
	Stop()
	String() string
	Type() dependency.Type
}

CatalogServiceQuery defines an interface for Consul Template service query

type MockResolver

type MockResolver struct {
	mock.Mock
}

MockResolver is a mock implementation of the ServiceResolver interface

func (*MockResolver) RemoveCacheItem

func (mr *MockResolver) RemoveCacheItem(function string)

RemoveCacheItem implements the interface method for removing cache items

func (*MockResolver) Resolve

func (mr *MockResolver) Resolve(function string) ([]string, error)

Resolve returns the arguments from the Mocks setup method

type Resolver

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

Resolver implements ServiceResolver

func NewResolver

func NewResolver(address string, logger hclog.Logger) *Resolver

NewResolver creates a new Resolver

func (*Resolver) RemoveCacheItem

func (sr *Resolver) RemoveCacheItem(function string)

RemoveCacheItem removes a service reference from the cache

func (*Resolver) Resolve

func (sr *Resolver) Resolve(function string) ([]string, error)

Resolve resolves a function name to an array of URI

type ServiceResolver

type ServiceResolver interface {
	Resolve(function string) ([]string, error)
	RemoveCacheItem(service string)
}

ServiceResolver uses consul to resolve a function name into addresses

type Watcher

type Watcher interface {
	Add(dependency dependency.Dependency) (bool, error)
	Remove(dependency dependency.Dependency) bool
	ItterateDataCh(itterateFunc)
}

Watcher is an interface to the Consul Template watcher struct

type WrappedWatcher

type WrappedWatcher struct {
	*watch.Watcher
}

WrappedWatcher wraps watch.View to allow testing

func (*WrappedWatcher) ItterateDataCh

func (ww *WrappedWatcher) ItterateDataCh(f itterateFunc)

ItterateDataCh returns the list of CatalogService from the View