You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
1.7 KiB
47 lines
1.7 KiB
package registry
|
|
|
|
import "context"
|
|
|
|
// Registrar is service registrar.
|
|
type Registrar interface {
|
|
// Register the registration.
|
|
Register(ctx context.Context, service *ServiceInstance) error
|
|
// Deregister the registration.
|
|
Deregister(ctx context.Context, service *ServiceInstance) error
|
|
}
|
|
|
|
// Discovery is service discovery.
|
|
type Discovery interface {
|
|
// GetService return the service instances in memory according to the service name.
|
|
GetService(ctx context.Context, serviceName string) ([]*ServiceInstance, error)
|
|
// Watch creates a watcher according to the service name.
|
|
Watch(ctx context.Context, serviceName string) (Watcher, error)
|
|
}
|
|
|
|
// Watcher is service watcher.
|
|
type Watcher interface {
|
|
// Next returns services in the following two cases:
|
|
// 1.the first time to watch and the service instance list is not empty.
|
|
// 2.any service instance changes found.
|
|
// if the above two conditions are not met, it will block until context deadline exceeded or canceled
|
|
Next() ([]*ServiceInstance, error)
|
|
// Stop close the watcher.
|
|
Stop() error
|
|
}
|
|
|
|
// ServiceInstance is an instance of a service in a discovery system.
|
|
type ServiceInstance struct {
|
|
// ID is the unique instance ID as registered.
|
|
ID string `json:"id"`
|
|
// Name is the service name as registered.
|
|
Name string `json:"name"`
|
|
// Version is the version of the compiled.
|
|
Version string `json:"version"`
|
|
// Metadata is the kv pair metadata associated with the service instance.
|
|
Metadata map[string]string `json:"metadata"`
|
|
// Endpoints are endpoint addresses of the service instance.
|
|
// schema:
|
|
// http://127.0.0.1:8000?isSecure=false
|
|
// grpc://127.0.0.1:9000?isSecure=false
|
|
Endpoints []string `json:"endpoints"`
|
|
}
|
|
|