Package consul
Overview ▹
Index ▹
type Client ¶
Client is a wrapper around the Consul API.
type Client interface { // Register a service with the local agent. Register(r *consul.AgentServiceRegistration) error // Deregister a service with the local agent. Deregister(r *consul.AgentServiceRegistration) error // Service Service(service, tag string, passingOnly bool, queryOpts *consul.QueryOptions) ([]*consul.ServiceEntry, *consul.QueryMeta, error) }
func NewClient ¶
func NewClient(c *consul.Client) Client
NewClient returns an implementation of the Client interface, wrapping a concrete Consul client.
type Registrar ¶
Registrar registers service instance liveness information to Consul.
type Registrar struct {
// contains filtered or unexported fields
}
func NewRegistrar ¶
func NewRegistrar(client Client, r *stdconsul.AgentServiceRegistration, logger log.Logger) *Registrar
NewRegistrar returns a Consul Registrar acting on the provided catalog registration.
func (*Registrar) Deregister ¶
func (p *Registrar) Deregister()
Deregister implements sd.Registrar interface.
func (*Registrar) Register ¶
func (p *Registrar) Register()
Register implements sd.Registrar interface.
type Subscriber ¶
Subscriber yields endpoints for a service in Consul. Updates to the service are watched and will update the Subscriber endpoints.
type Subscriber struct {
// contains filtered or unexported fields
}
func NewSubscriber ¶
func NewSubscriber(client Client, factory sd.Factory, logger log.Logger, service string, tags []string, passingOnly bool) *Subscriber
NewSubscriber returns a Consul subscriber which returns endpoints for the requested service. It only returns instances for which all of the passed tags are present.
func (*Subscriber) Endpoints ¶
func (s *Subscriber) Endpoints() ([]endpoint.Endpoint, error)
Endpoints implements the Subscriber interface.
func (*Subscriber) Stop ¶
func (s *Subscriber) Stop()
Stop terminates the subscriber.