X

Class ConsulServiceRegistry

An implementation of a Consul service registry

Inheritance
System.Object
ConsulServiceRegistry
Implements
IServiceRegistry<IConsulRegistration>
Namespace: Steeltoe.Discovery.Consul.Registry
Assembly: Steeltoe.Discovery.Consul.dll
Syntax
public class ConsulServiceRegistry : object, IConsulServiceRegistry

Constructors

| Edit this page View Source

ConsulServiceRegistry(IConsulClient, IOptionsMonitor<ConsulDiscoveryOptions>, IScheduler, ILogger<ConsulServiceRegistry>)

Initializes a new instance of the ConsulServiceRegistry class.

Declaration
public ConsulServiceRegistry(IConsulClient client, IOptionsMonitor<ConsulDiscoveryOptions> optionsMonitor, IScheduler scheduler = null, ILogger<ConsulServiceRegistry> logger = null)
Parameters
Type Name Description
IConsulClient client

the Consul client to use
IOptionsMonitor<ConsulDiscoveryOptions> optionsMonitor

the configuration options
IScheduler scheduler

a scheduler to use for heart beats
ILogger<ConsulServiceRegistry> logger

an optional logger
| Edit this page View Source

ConsulServiceRegistry(IConsulClient, ConsulDiscoveryOptions, IScheduler, ILogger<ConsulServiceRegistry>)

Initializes a new instance of the ConsulServiceRegistry class.

Declaration
public ConsulServiceRegistry(IConsulClient client, ConsulDiscoveryOptions options, IScheduler scheduler = null, ILogger<ConsulServiceRegistry> logger = null)
Parameters
Type Name Description
IConsulClient client

the Consul client to use
ConsulDiscoveryOptions options

the configuration options
IScheduler scheduler

a scheduler to use for heart beats
ILogger<ConsulServiceRegistry> logger

an optional logger

Methods

| Edit this page View Source

Deregister(IConsulRegistration)

Declaration
public void Deregister(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
| Edit this page View Source

DeregisterAsync(IConsulRegistration)

Declaration
public Task DeregisterAsync(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
Returns
Type Description
Task
| Edit this page View Source

Dispose()

Declaration
public void Dispose()
| Edit this page View Source

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
| Edit this page View Source

Finalize()

Declaration
protected void Finalize()
| Edit this page View Source

GetStatus<S>(IConsulRegistration)

Declaration
public S GetStatus<S>(IConsulRegistration registration)

    where S : class
Parameters
Type Name Description
IConsulRegistration registration
Returns
Type Description
S
Type Parameters
Name Description
S
| Edit this page View Source

GetStatusAsync(IConsulRegistration)

Declaration
public Task<object> GetStatusAsync(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
Returns
Type Description
Task<System.Object>
| Edit this page View Source

GetStatusAsyncInternal(IConsulRegistration)

Declaration
public async Task<object> GetStatusAsyncInternal(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
Returns
Type Description
Task<System.Object>
| Edit this page View Source

Register(IConsulRegistration)

Declaration
public void Register(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
| Edit this page View Source

RegisterAsync(IConsulRegistration)

Declaration
public Task RegisterAsync(IConsulRegistration registration)
Parameters
Type Name Description
IConsulRegistration registration
Returns
Type Description
Task
| Edit this page View Source

SetStatus(IConsulRegistration, String)

Declaration
public void SetStatus(IConsulRegistration registration, string status)
Parameters
Type Name Description
IConsulRegistration registration
System.String status
| Edit this page View Source

SetStatusAsync(IConsulRegistration, String)

Declaration
public Task SetStatusAsync(IConsulRegistration registration, string status)
Parameters
Type Name Description
IConsulRegistration registration
System.String status
Returns
Type Description
Task

Implements

IServiceRegistry<>