DynamicEndpointGroup (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.common.util.AbstractListenable<List<Endpoint>>
- - com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

All Implemented Interfaces:

EndpointGroup, EndpointSelector, AsyncCloseable, Listenable<List<Endpoint>>, ListenableAsyncCloseable, AutoCloseable

Direct Known Subclasses:

DnsAddressEndpointGroup, DnsServiceEndpointGroup, DnsTextEndpointGroup, HealthCheckedEndpointGroup, PropertiesEndpointGroup
```
public class DynamicEndpointGroup
extends AbstractListenable<List<Endpoint>>
implements EndpointGroup, ListenableAsyncCloseable
```
A dynamic EndpointGroup. The list of Endpoints can be updated dynamically.

Constructor Summary

Constructors
Constructor and Description
`DynamicEndpointGroup()` Creates a new empty `DynamicEndpointGroup` that uses `EndpointSelectionStrategy.weightedRoundRobin()` as its `EndpointSelectionStrategy`.
`DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy)` Creates a new empty `DynamicEndpointGroup` that uses the specified `EndpointSelectionStrategy`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addEndpoint(Endpoint e)` Adds the specified `Endpoint` to current `Endpoint` list.
`void`	`close()` Releases any underlying resources held by this object synchronously.
`CompletableFuture<?>`	`closeAsync()` Releases any underlying resources held by this object asynchronously.
`protected void`	`doCloseAsync(CompletableFuture<?> future)` Override this method to release the resources held by this `EndpointGroup` and complete the specified `CompletableFuture`.
`List<Endpoint>`	`endpoints()` Returns the endpoints held by this `EndpointGroup`.
`boolean`	`isClosed()` Returns whether `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` operation has been completed.
`boolean`	`isClosing()` Returns whether `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` has been called.
`protected void`	`removeEndpoint(Endpoint e)` Removes the specified `Endpoint` from current `Endpoint` list.
`Endpoint`	`select(ClientRequestContext ctx)` Selects an `Endpoint` from this `EndpointGroup`.
`EndpointSelectionStrategy`	`selectionStrategy()` Returns the `EndpointSelectionStrategy` of this `EndpointGroup`.
`protected void`	`setEndpoints(Iterable<Endpoint> endpoints)` Sets the specified `Endpoint`s as current `Endpoint` list.
`CompletableFuture<?>`	`whenClosed()` Returns the `CompletableFuture` which is completed after the `AsyncCloseable.close()` or `AsyncCloseable.closeAsync()` operation is completed.
`CompletableFuture<List<Endpoint>>`	`whenReady()` Returns the `CompletableFuture` which is completed when the initial `Endpoint`s are ready.

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable
addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup
addListener, awaitInitialEndpoints, awaitInitialEndpoints, empty, initialEndpointsFuture, of, of, of, of, orElse, removeListener

- Constructor Detail
  - DynamicEndpointGroup
```
public DynamicEndpointGroup()
```
    Creates a new empty DynamicEndpointGroup that uses EndpointSelectionStrategy.weightedRoundRobin() as its EndpointSelectionStrategy.
  - DynamicEndpointGroup
```
public DynamicEndpointGroup(EndpointSelectionStrategy selectionStrategy)
```
    Creates a new empty DynamicEndpointGroup that uses the specified EndpointSelectionStrategy.
- Method Detail
  - endpoints
```
public final List<Endpoint> endpoints()
```
    Description copied from interface: EndpointGroup
    
    Returns the endpoints held by this EndpointGroup.
    
    Specified by:
    
    endpoints in interface EndpointGroup
  - selectionStrategy
```
public final EndpointSelectionStrategy selectionStrategy()
```
    Description copied from interface: EndpointGroup
    
    Returns the EndpointSelectionStrategy of this EndpointGroup.
    
    Specified by:
    
    selectionStrategy in interface EndpointGroup
  - select
```
public final Endpoint select(ClientRequestContext ctx)
```
    Description copied from interface: EndpointGroup
    
    Selects an Endpoint from this EndpointGroup.
    
    Specified by:
    
    select in interface EndpointGroup
    
    Specified by:
    
    select in interface EndpointSelector
    
    Returns:
    
    the Endpoint selected by the EndpointSelectionStrategy, which was specified when constructing this EndpointGroup.
  - whenReady
```
public CompletableFuture<List<Endpoint>> whenReady()
```
    Returns the CompletableFuture which is completed when the initial Endpoints are ready.
    
    Specified by:
    
    whenReady in interface EndpointGroup
  - addEndpoint
```
protected final void addEndpoint(Endpoint e)
```
    Adds the specified Endpoint to current Endpoint list.
  - removeEndpoint
```
protected final void removeEndpoint(Endpoint e)
```
    Removes the specified Endpoint from current Endpoint list.
  - setEndpoints
```
protected final void setEndpoints(Iterable<Endpoint> endpoints)
```
    Sets the specified Endpoints as current Endpoint list.
  - isClosing
```
public final boolean isClosing()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() has been called.
    
    Specified by:
    
    isClosing in interface ListenableAsyncCloseable
    
    See Also:
    
    ListenableAsyncCloseable.isClosed()
  - isClosed
```
public final boolean isClosed()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns whether AsyncCloseable.close() or AsyncCloseable.closeAsync() operation has been completed.
    
    Specified by:
    
    isClosed in interface ListenableAsyncCloseable
    
    See Also:
    
    ListenableAsyncCloseable.isClosing()
  - whenClosed
```
public final CompletableFuture<?> whenClosed()
```
    Description copied from interface: ListenableAsyncCloseable
    
    Returns the CompletableFuture which is completed after the AsyncCloseable.close() or AsyncCloseable.closeAsync() operation is completed.
    
    Specified by:
    
    whenClosed in interface ListenableAsyncCloseable
  - closeAsync
```
public final CompletableFuture<?> closeAsync()
```
    Description copied from interface: AsyncCloseable
    
    Releases any underlying resources held by this object asynchronously.
    
    Specified by:
    
    closeAsync in interface AsyncCloseable
    
    Returns:
    
    the CompletableFuture which is completed after the resources are released
  - doCloseAsync
```
protected void doCloseAsync(CompletableFuture<?> future)
```
    Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
  - close
```
public final void close()
```
    Description copied from interface: AsyncCloseable
    
    Releases any underlying resources held by this object synchronously.
    
    Specified by:
    
    close in interface AsyncCloseable
    
    Specified by:
    
    close in interface AutoCloseable

Class DynamicEndpointGroup

Constructor Summary

Method Summary

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

Methods inherited from class java.lang.Object

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup

Constructor Detail

DynamicEndpointGroup

DynamicEndpointGroup

Method Detail

endpoints

selectionStrategy

select

whenReady

addEndpoint

removeEndpoint

setEndpoints

isClosing

isClosed

whenClosed

closeAsync

doCloseAsync

close