io.servicetalk.client.api

Class ServiceDiscovererFilter<UnresolvedAddress,ResolvedAddress,Event extends ServiceDiscovererEvent<ResolvedAddress>>

java.lang.Object

io.servicetalk.client.api.ServiceDiscovererFilter<UnresolvedAddress,ResolvedAddress,Event>

Type Parameters:

UnresolvedAddress - The type of address before resolution.

ResolvedAddress - The type of address after resolution.

Event - Type of ServiceDiscovererEvents published from ServiceDiscoverer.discover(Object).

All Implemented Interfaces:

ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,Event>, AsyncCloseable, ListenableAsyncCloseable

Direct Known Subclasses:

RetryingDnsServiceDiscovererFilter

public class ServiceDiscovererFilter<UnresolvedAddress,ResolvedAddress,Event extends ServiceDiscovererEvent<ResolvedAddress>>
extends java.lang.Object
implements ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,Event>

A ServiceDiscoverer that delegates all methods to a different ServiceDiscoverer.

Constructor Summary

Constructors

Constructor and Description
ServiceDiscovererFilter(ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,Event> delegate) Create a new instance.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
Completable	closeAsyncGracefully() Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
Publisher<Event>	discover(UnresolvedAddress unresolvedAddress) Subscribe to the service discovery system for changes in the available ResolvedAddress associated with address.
Completable	onClose() Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceDiscovererFilter

public ServiceDiscovererFilter(ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,Event> delegate)

Create a new instance.

Parameters:

delegate - The ServiceDiscoverer to delegate all calls to.

Method Detail

discover

public Publisher<Event> discover(UnresolvedAddress unresolvedAddress)

Description copied from interface: ServiceDiscoverer

Subscribe to the service discovery system for changes in the available ResolvedAddress associated with address.

In general a call to this method will continue to discover changes related to address until the PublisherSource.Subscription corresponding to the return value is cancelled via Cancellable.cancel() or there are no more changes to publish.

Specified by:

discover in interface ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,Event extends ServiceDiscovererEvent<ResolvedAddress>>

Parameters:

unresolvedAddress - the service address to discover. Examples of what this address maybe are:

• hostname/port (e.g. InetAddress)
• service name
• it may be a list of attributes which describe the service attributes to resolve
• something else

Returns:

a Publisher that represents a stream of events from the service discovery system.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.