Interface IDiscoveryClient

Provides access to remote service instances using a discovery server.

Namespace: Steeltoe.Common.Discovery

Assembly: Steeltoe.Common.dll

Syntax

public interface IDiscoveryClient

Properties

| Edit this page View Source

Description

Gets a human-readable description of this discovery client.

Declaration

string Description { get; }

Property Value

Type	Description
System.String

Methods

| Edit this page View Source

GetInstancesAsync(String, CancellationToken)

Gets all service instances associated with the specified service ID from the discovery server.

Declaration

Task<IList<IServiceInstance>> GetInstancesAsync(string serviceId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	serviceId	The ID of the service to lookup.
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task<IList<IServiceInstance>>	The list of remote service instances.

| Edit this page View Source

GetLocalServiceInstance()

Gets information used to register the local service instance (this app) to the discovery server.

Declaration

IServiceInstance GetLocalServiceInstance()

Returns

Type	Description
IServiceInstance	The service instance that represents this app, or `null` when unavailable.

| Edit this page View Source

GetServiceIdsAsync(CancellationToken)

Gets all registered service IDs from the discovery server.

Declaration

Task<ISet<string>> GetServiceIdsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task<ISet<System.String>>	The list of service IDs.

| Edit this page View Source

ShutdownAsync(CancellationToken)

Deregisters the local service (this app) from the discovery server.

Declaration

Task ShutdownAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The token to monitor for cancellation requests.

Returns

Type	Description
Task

Remarks

This method exists for two reasons, instead of just reusing . The first reason is that this method enables cancellation. The second reason is more complicated. Deregistration typically requires to send an HTTP request to the discovery server. When using IHttpClientFactory, it requires the IoC container to obtain an . But that fails when the container is being disposed. Deregistration must be performed earlier. That's why implementations should register DiscoveryClientHostedService in the IoC container, which is a hosted service that performs deregistration (by calling this method) when the app is terminating. At that time, the IoC container is still accessible.