EndpointGroup (filter-service-metrics 1.13 1.13 API)

All Superinterfaces:

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

All Known Implementing Classes:

DnsAddressEndpointGroup, DnsServiceEndpointGroup, DnsTextEndpointGroup, DynamicEndpointGroup, Endpoint, HealthCheckedEndpointGroup, PropertiesEndpointGroup
```
public interface EndpointGroup
extends Listenable<List<Endpoint>>, EndpointSelector, AsyncCloseable
```
A list of Endpoints.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default void`	`addListener(Consumer<? super List<Endpoint>> listener)` Adds a `Consumer` that will be invoked when a `Listenable` changes its value.
`default List<Endpoint>`	`awaitInitialEndpoints()` Deprecated. Use `whenReady()` and `CompletableFuture.get()`.
`default List<Endpoint>`	`awaitInitialEndpoints(long timeout, TimeUnit unit)` Deprecated. Use `whenReady()` and `CompletableFuture.get(long, TimeUnit)`.
`static EndpointGroup`	`empty()` Returns a singleton `EndpointGroup` which does not contain any `Endpoint`s.
`List<Endpoint>`	`endpoints()` Returns the endpoints held by this `EndpointGroup`.
`default CompletableFuture<List<Endpoint>>`	`initialEndpointsFuture()` Deprecated. Use `whenReady()`.
`static EndpointGroup`	`of(EndpointGroup... endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`static EndpointGroup`	`of(EndpointSelectionStrategy selectionStrategy, EndpointGroup... endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`static EndpointGroup`	`of(EndpointSelectionStrategy selectionStrategy, Iterable<? extends EndpointGroup> endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`static EndpointGroup`	`of(Iterable<? extends EndpointGroup> endpointGroups)` Returns an `EndpointGroup` that combines all the `Endpoint`s of `endpointGroups`.
`default EndpointGroup`	`orElse(EndpointGroup nextEndpointGroup)` Creates a new `EndpointGroup` that tries this `EndpointGroup` first and then the specified `EndpointGroup` when this `EndpointGroup` does not have a requested resource.
`default void`	`removeListener(Consumer<?> listener)` Remove a listener.
`Endpoint`	`select(ClientRequestContext ctx)` Selects an `Endpoint` from this `EndpointGroup`.
`EndpointSelectionStrategy`	`selectionStrategy()` Returns the `EndpointSelectionStrategy` of this `EndpointGroup`.
`CompletableFuture<List<Endpoint>>`	`whenReady()` Returns a `CompletableFuture` which is completed when the initial `Endpoint`s are ready.

Methods inherited from interface com.linecorp.armeria.common.util.AsyncCloseable
close, closeAsync

- Method Detail
  - empty
```
static EndpointGroup empty()
```
    Returns a singleton EndpointGroup which does not contain any Endpoints.
  - of
```
static EndpointGroup of(EndpointGroup... endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set. The EndpointGroup returned by this method will use EndpointSelectionStrategy.weightedRoundRobin() for selecting an Endpoint.
  - of
```
static EndpointGroup of(EndpointSelectionStrategy selectionStrategy,
                        EndpointGroup... endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.
  - of
```
static EndpointGroup of(Iterable<? extends EndpointGroup> endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set. The EndpointGroup returned by this method will use EndpointSelectionStrategy.weightedRoundRobin() for selecting an Endpoint.
  - of
```
static EndpointGroup of(EndpointSelectionStrategy selectionStrategy,
                        Iterable<? extends EndpointGroup> endpointGroups)
```
    Returns an EndpointGroup that combines all the Endpoints of endpointGroups. endpointGroups can be instances of Endpoint as well, any EndpointGroups and Endpoint will all be combined into a single EndpointGroup that contains the total set.
  - endpoints
```
List<Endpoint> endpoints()
```
    Returns the endpoints held by this EndpointGroup.
  - selectionStrategy
```
EndpointSelectionStrategy selectionStrategy()
```
    Returns the EndpointSelectionStrategy of this EndpointGroup.
  - select
```
Endpoint select(ClientRequestContext ctx)
```
    Selects an Endpoint from this EndpointGroup.
    
    Specified by:
    
    select in interface EndpointSelector
    
    Returns:
    
    the Endpoint selected by the EndpointSelectionStrategy, which was specified when constructing this EndpointGroup.
  - whenReady
```
CompletableFuture<List<Endpoint>> whenReady()
```
    Returns a CompletableFuture which is completed when the initial Endpoints are ready.
  - initialEndpointsFuture
```
@Deprecated
default CompletableFuture<List<Endpoint>> initialEndpointsFuture()
```
    Deprecated. Use whenReady().
    
    Returns a CompletableFuture which is completed when the initial Endpoints are ready.
  - awaitInitialEndpoints
```
@Deprecated
default List<Endpoint> awaitInitialEndpoints()
                                                  throws InterruptedException
```
    Deprecated. Use whenReady() and CompletableFuture.get().
    
    Waits until the initial Endpoints are ready.
    
    Throws:
    
    CancellationException - if AsyncCloseable.close() was called before the initial Endpoints are set
    
    InterruptedException
  - awaitInitialEndpoints
```
@Deprecated
default List<Endpoint> awaitInitialEndpoints(long timeout,
                                                         TimeUnit unit)
                                                  throws InterruptedException,
                                                         TimeoutException
```
    Deprecated. Use whenReady() and CompletableFuture.get(long, TimeUnit).
    
    Waits until the initial Endpoints are ready, with timeout.
    
    Throws:
    
    CancellationException - if AsyncCloseable.close() was called before the initial Endpoints are set
    
    TimeoutException - if the initial Endpoints are not set until timeout
    
    InterruptedException
  - addListener
```
default void addListener(Consumer<? super List<Endpoint>> listener)
```
    Description copied from interface: Listenable
    
    Adds a Consumer that will be invoked when a Listenable changes its value.
    
    Specified by:
    
    addListener in interface Listenable<List<Endpoint>>
  - removeListener
```
default void removeListener(Consumer<?> listener)
```
    Description copied from interface: Listenable
    
    Remove a listener.
    
    Specified by:
    
    removeListener in interface Listenable<List<Endpoint>>
  - orElse
```
default EndpointGroup orElse(EndpointGroup nextEndpointGroup)
```
    Creates a new EndpointGroup that tries this EndpointGroup first and then the specified EndpointGroup when this EndpointGroup does not have a requested resource.
    
    Parameters:
    
    nextEndpointGroup - the EndpointGroup to try secondly.

Interface EndpointGroup

Method Summary

Methods inherited from interface com.linecorp.armeria.common.util.AsyncCloseable

Method Detail

empty

of

of

of

of

endpoints

selectionStrategy

select

whenReady

initialEndpointsFuture

awaitInitialEndpoints

awaitInitialEndpoints

addListener

removeListener

orElse