registry

Documentation

Index

• Constants
• Variables
• type Log
• type OpOption
  • func WithAddrs(addrs ...string) OpOption
  • func WithAuth(username, password string) OpOption
  • func WithLogger(logger Log) OpOption
  • func WithTimeout(timeout time.Duration) OpOption
• type OpRegisterOption
  • func WithRefresh() OpRegisterOption
  • func WithRegistryTTL(ttl time.Duration) OpRegisterOption
• type Option
• type RegisterOption
• type Registry
• type WatchEvent
• type WatchEventType
• type WatchInfoType

Constants

const (
	//节点实例信息类型，主要有service provider注册
	WatchInfoTypeInstance = "instance"
	//节点属性信息类型，主要有后台干预设置
	WatchInfoTypeProperty = "property"
)

Variables

var DefaultLogger = new(logger)

默认logger

Types

type Log

type Log interface {
	Debug(args ...interface{})
	Trace(args ...interface{})
	Warn(args ...interface{})
	Error(args ...interface{})
}

日志

type OpOption

type OpOption func(op *Option)

func WithAddrs

func WithAddrs(addrs ...string) OpOption

func WithAuth

func WithAuth(username, password string) OpOption

func WithLogger

func WithLogger(logger Log) OpOption

func WithTimeout

func WithTimeout(timeout time.Duration) OpOption

type OpRegisterOption

type OpRegisterOption func(op *RegisterOption)

func WithRefresh

func WithRefresh() OpRegisterOption

是否强制刷新，强制刷新时，重置数据（etcd会重新put数据）

func WithRegistryTTL

func WithRegistryTTL(ttl time.Duration) OpRegisterOption

续约时间

type Option

type Option struct {
	Addrs    []string
	Timeout  time.Duration
	Username string
	Password string

	Logger Log
}

后端存储option

type RegisterOption

type RegisterOption struct {
	//租约时间
	TTL time.Duration
	//是否强制更新
	Refresh bool
}

type Registry

type Registry interface {
	//Registry 初始化操作
	Init(opts ...OpOption) error
	//服务注册,返回元组信息，discovery需要将返回的MD信息添加到Instance的Metadata中 @todo keepalive是否共用此接口
	Register(instance *dm.Instance, opts ...OpRegisterOption) error
	//服务解除注册,client可以采用信号等机制退出时，调用解除注册的接口
	Deregister(instance *dm.Instance) error
	//根据ServiceName获取服务信息（Instance列表）@todo 如果keeper挂了，过一段时间重启后，可能数据已经变了，甚至部分服务为空了，此时应该如何处理?需要加策略，client端只有接受到当前服务个数的x%，才接受
	GetService(serviceName string) (*dm.Service, error)
	//列出已注册的所有service列表(该接口比较重，应该是keeper首次启动的时候调用一次,其余时间不会调用)
	ListServices() ([]*dm.Service, error)
	//订阅相关的service变化，支持监测所有service,这里的watcher需要抽象一下，不仅仅适用于etcd
	Watch() (<-chan *WatchEvent, error)
	//registry类型，例如etcd、consul等
	Type() string
	//属性设置
	SetProperty(property *dm.Property) error
}

服务注册interface,只在keeper中调用，不暴露给client。 （client通过grpc接口更keeper通信，然后keeper通过该接口进行注册)

type WatchEvent

type WatchEvent struct {
	//事件类型,主要用于instance create/modify/delete
	EventType WatchEventType
	//信息类型，主要分为instance和property
	InfoType WatchEventType
	//数据信息
	Data interface{}
	//版本号，用于更新service的版本
	Version int64
}

watch返回的数据结构

type WatchEventType

type WatchEventType string

watch 事件类型

const (
	WatchEventTypeCreate WatchEventType = "create"
	WatchEventTypeModify WatchEventType = "modify"
	WatchEventTypeDelete WatchEventType = "delete"
)

type WatchInfoType

type WatchInfoType string

watch 信息类型