Package io.servicetalk.client.api

Class DelegatingServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E extends ServiceDiscovererEvent<ResolvedAddress>>

java.lang.Object

io.servicetalk.client.api.DelegatingServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E>

Type Parameters:

UnresolvedAddress - The type of address before resolution.

ResolvedAddress - The type of address after resolution.

E - Type of ServiceDiscovererEvents published from discover(Object).

All Implemented Interfaces:

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

public class DelegatingServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E extends ServiceDiscovererEvent<ResolvedAddress>>
extends Object
implements ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E>

A ServiceDiscoverer that delegates all methods to another ServiceDiscoverer.

Constructor Summary

Constructors

Constructor	Description
DelegatingServiceDiscoverer(ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E> delegate)	Creates a new instance.

Method Summary

Modifier and Type	Method	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.
protected final ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E>	delegate()	Returns the ServiceDiscoverer delegate.
Publisher<Collection<E>>	discover(UnresolvedAddress address)	Subscribe to the service discovery system for changes in the available ServiceDiscoverer associated with address.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	onClosing()	Returns a Completable that is notified when closing begins.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingServiceDiscoverer

public DelegatingServiceDiscoverer(ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E> delegate)

Creates a new instance.

Parameters:

delegate - ServiceDiscoverer to which all methods are delegated.

Method Details

delegate

protected final ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E> delegate()

Returns the ServiceDiscoverer delegate.

Returns:

Delegate ServiceDiscoverer.

discover

public Publisher<Collection<E>> discover(UnresolvedAddress address)

Description copied from interface: ServiceDiscoverer

Subscribe to the service discovery system for changes in the available ServiceDiscoverer 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,E extends ServiceDiscovererEvent<ResolvedAddress>>

Parameters:

address - 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.

onClosing

public Completable onClosing()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified when closing begins.

Closing begin might be when a close operation is initiated locally (e.g. subscribing to AsyncCloseable.closeAsync()) or it could also be a transport event received from a remote peer (e.g. read a connection: close header).

For backwards compatibility this method maybe functionally equivalent to ListenableAsyncCloseable.onClose(). Therefore, provides a best-effort leading edge notification of closing, but may fall back to notification on trailing edge.

The goal of this method is often to notify asap when closing so this method may not be offloaded and care must be taken to avoid blocking if subscribing to the return Completable.

Specified by:

onClosing in interface ListenableAsyncCloseable

Returns:

a Completable that is notified when closing begins.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable 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.

toString

public String toString()

Overrides:

toString in class Object