Index (servicetalk-client-api 0.42.45 API)

A B C D E F G H I L N O P R S T U V W

A

add(PartitionAttributes.Key<T>, T) - Method in interface PartitionAttributesBuilder: Deprecated.

Add a key/value pair to this builder.
add(PartitionAttributes) - Method in interface PartitionMap: Deprecated.

Add a new PartitionAttributes that is absolutely specified.
address() - Method in class DefaultGroupKey
address() - Method in class DefaultServiceDiscovererEvent
address() - Method in interface GroupKey: Get the address to use when looking for or creating a new client.
address() - Method in interface ServiceDiscovererEvent: Get the resolved address which is the subject of this event.
append(ConnectionFactoryFilter<ResolvedAddress, C>) - Method in interface ConnectionFactoryFilter: Deprecated.
consider using higher level client builders to append filters.
AVAILABLE - Static variable in class ServiceDiscovererEvent.Status: Signifies the ServiceDiscovererEvent.address() is available for use in connection establishment.

B

build() - Method in interface PartitionAttributesBuilder: Deprecated.

Build a PartitionAttributes corresponding to the previous PartitionAttributesBuilder.add(PartitionAttributes.Key, Object) calls.

C

ClientGroup<Key,Client extends ListenableAsyncCloseable> - Interface in io.servicetalk.client.api: A data-structure capable of holding arbitrary number of clients and bridging lifecycle events across all clients managed by the group.
closeAsync() - Method in class DelegatingConnectionFactory
closeAsync() - Method in class DelegatingServiceDiscoverer
closeAsyncGracefully() - Method in class DelegatingConnectionFactory
closeAsyncGracefully() - Method in class DelegatingServiceDiscoverer
ClosedPartitionException - Exception in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
ClosedPartitionException(PartitionAttributes, String) - Constructor for exception ClosedPartitionException: Deprecated.

Create a new instance.
compareTo(PartitionAttributes.Key) - Method in class PartitionAttributes.Key: Deprecated.
ConnectionFactory<ResolvedAddress,C extends ListenableAsyncCloseable> - Interface in io.servicetalk.client.api: A factory for creating new connections.
ConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable> - Interface in io.servicetalk.client.api: A contract to decorate ConnectionFactory instances for the purpose of filtering.
ConnectionLimitReachedException - Exception in io.servicetalk.client.api: Thrown when the number of connections reached their limit for a given resource (i.e.
ConnectionLimitReachedException(String) - Constructor for exception ConnectionLimitReachedException: Creates a new instance.
ConnectionRejectedException - Exception in io.servicetalk.client.api: Thrown when a newly created connection was rejected.
ConnectionRejectedException(String) - Constructor for exception ConnectionRejectedException: Creates a new instance.
ConnectionRejectedException(String, Throwable) - Constructor for exception ConnectionRejectedException: Creates a new instance.
ConnectTimeoutException - Exception in io.servicetalk.client.api: Throws when a connect operations failed because of a timeout.
ConnectTimeoutException(String, Throwable) - Constructor for exception ConnectTimeoutException: Create a new instance.
ConsumableEvent<T> - Interface in io.servicetalk.client.api: A container for an event that requires acknowledgement when the event is consumed via ConsumableEvent.eventConsumed().
contains(PartitionAttributes.Key<T>) - Method in interface PartitionAttributes: Deprecated.

Determine if there is a value associated with key.
create(ConnectionFactory<ResolvedAddress, C>) - Method in interface ConnectionFactoryFilter: Decorates the passed original ConnectionFactory to add the filtering logic.
create(ConnectionFactory<ResolvedAddress, C>) - Method in class DelegatingConnectionFactoryFilter
create(ConnectionFactory<ResolvedAddress, C>) - Method in class LimitingConnectionFactoryFilter
create(ConnectionFactory<ResolvedAddress, C>) - Method in class TransportObserverConnectionFactoryFilter

D

DefaultGroupKey<Address> - Class in io.servicetalk.client.api: A default implementation of GroupKey.
DefaultGroupKey(Address, ExecutionContext<?>) - Constructor for class DefaultGroupKey: Create a new instance.
DefaultServiceDiscovererEvent<T> - Class in io.servicetalk.client.api: Default implementation of ServiceDiscovererEvent.
DefaultServiceDiscovererEvent(T, ServiceDiscovererEvent.Status) - Constructor for class DefaultServiceDiscovererEvent: Create a new instance.
delay() - Method in interface DelayedRetryException: A constant delay to apply.
DelayedRetryException - Interface in io.servicetalk.client.api: An interface that enhances any exception to provide a constant delay to be applied when it needs to be retried.
delegate() - Method in class DelegatingConnectionFactory: Returns the ConnectionFactory delegate.
delegate() - Method in class DelegatingConnectionFactoryFilter: Returns the ConnectionFactoryFilter delegate.
delegate() - Method in class DelegatingServiceDiscoverer: Returns the ServiceDiscoverer delegate.
DelegatingConnectionFactory<ResolvedAddress,C extends ListenableAsyncCloseable> - Class in io.servicetalk.client.api: A ConnectionFactory that delegates all methods to another ConnectionFactory.
DelegatingConnectionFactory(ConnectionFactory<ResolvedAddress, C>) - Constructor for class DelegatingConnectionFactory: Create a new instance.
DelegatingConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable> - Class in io.servicetalk.client.api: A ConnectionFactoryFilter that delegates all methods to another ConnectionFactoryFilter.
DelegatingConnectionFactoryFilter(ConnectionFactoryFilter<ResolvedAddress, C>) - Constructor for class DelegatingConnectionFactoryFilter: Create a new instance.
DelegatingServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E extends ServiceDiscovererEvent<ResolvedAddress>> - Class in io.servicetalk.client.api: A ServiceDiscoverer that delegates all methods to another ServiceDiscoverer.
DelegatingServiceDiscoverer(ServiceDiscoverer<UnresolvedAddress, ResolvedAddress, E>) - Constructor for class DelegatingServiceDiscoverer: Creates a new instance.
discover(UnresolvedAddress) - Method in class DelegatingServiceDiscoverer
discover(UnresolvedAddress) - Method in interface ServiceDiscoverer: Subscribe to the service discovery system for changes in the available ResolvedAddress associated with address.
DuplicateAttributeException - Exception in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
DuplicateAttributeException(PartitionAttributes.Key, String) - Constructor for exception DuplicateAttributeException: Deprecated.

Create a new instance.

E

equals(Object) - Method in class DefaultGroupKey
equals(Object) - Method in class DefaultServiceDiscovererEvent
equals(Object) - Method in class PartitionAttributes.Key: Deprecated.
equals(Object) - Method in class ServiceDiscovererEvent.Status
event() - Method in interface ConsumableEvent: Get the event.
eventConsumed() - Method in interface ConsumableEvent: Signify the ConsumableEvent.event() has been consumed and any side effects have taken place.
eventStream() - Method in interface LoadBalancer: A Publisher of events provided by this LoadBalancer.
executionContext() - Method in class DefaultGroupKey
executionContext() - Method in interface GroupKey: Get the ExecutionContext to use when looking for or creating a new client.
EXPIRED - Static variable in class ServiceDiscovererEvent.Status: Signifies the ServiceDiscovererEvent.address() is expired and should not be used for establishing new connections.

F

forEach(BiConsumer<PartitionAttributes.Key, Object>) - Method in interface PartitionAttributes: Deprecated.

Iterate over the key/value pairs in this collection.
from(Function<Key, Client>) - Static method in interface ClientGroup: Creates a ClientGroup based on a factory of clients of type Client.

G

get(Key) - Method in interface ClientGroup: Return the Client identified by the provided key or create a new one when none exists.
get(PartitionAttributes.Key<T>) - Method in interface PartitionAttributes: Deprecated.

Get the value associated with key.
get(PartitionAttributes) - Method in interface PartitionMap: Deprecated.

Get the partition value corresponding to the PartitionAttributes parameter.
getKey() - Method in exception DuplicateAttributeException: Deprecated.

Get the PartitionAttributes.Key which corresponds to the exception.
getPartitionSelector() - Method in exception ClosedPartitionException: Deprecated.

Get the PartitionAttributes that was used to select the partition.
getPartitionSelector() - Method in exception UnknownPartitionException: Deprecated.

Get the PartitionAttributes that was used to select the partition.
GroupKey<Address> - Interface in io.servicetalk.client.api: Identifies a client within a group of clients, and provides enough information to create a client if non exist.

H

hashCode() - Method in class DefaultGroupKey
hashCode() - Method in class DefaultServiceDiscovererEvent
hashCode() - Method in class PartitionAttributes.Key: Deprecated.
hashCode() - Method in class ServiceDiscovererEvent.Status

I

identity() - Static method in interface ConnectionFactoryFilter: Returns a function that always returns its input ConnectionFactory.
io.servicetalk.client.api - package io.servicetalk.client.api: API definitions for Client use cases.
io.servicetalk.client.api.partition - package io.servicetalk.client.api.partition: Client APIs targeted at partitioned use cases.
isConnectAllowed(ResolvedAddress) - Method in interface LimitingConnectionFactoryFilter.ConnectionLimiter: Requests permission to create a single connection to the passed target address.
isEmpty() - Method in interface PartitionAttributes: Deprecated.

Determine if there are no key/value pairs in this collection.
isReady() - Method in interface LoadBalancerReadyEvent: A hint which can be used to determine if the LoadBalancer is "ready".

L

LimitingConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable> - Class in io.servicetalk.client.api: A ConnectionFactory that limits the total number of active connections created using this ConnectionFactory.
LimitingConnectionFactoryFilter.ConnectionLimiter<ResolvedAddress,C extends ListenableAsyncCloseable> - Interface in io.servicetalk.client.api: A contract to limit number of connections created by LimitingConnectionFactoryFilter.
LOAD_BALANCER_NOT_READY_EVENT - Static variable in interface LoadBalancerReadyEvent: A LoadBalancerReadyEvent that returns false for LoadBalancerReadyEvent.isReady().
LOAD_BALANCER_READY_EVENT - Static variable in interface LoadBalancerReadyEvent: A LoadBalancerReadyEvent that returns true for LoadBalancerReadyEvent.isReady().
LoadBalancedAddress<C extends LoadBalancedConnection> - Interface in io.servicetalk.client.api: An address managed by a LoadBalancer.
LoadBalancedConnection - Interface in io.servicetalk.client.api: A connection managed by a LoadBalancer.
LoadBalancer<C extends LoadBalancedConnection> - Interface in io.servicetalk.client.api: Given multiple SocketAddresses select the most desired SocketAddress to use.
LoadBalancerFactory<ResolvedAddress,C extends LoadBalancedConnection> - Interface in io.servicetalk.client.api: A factory for creating LoadBalancer instances.
LoadBalancerReadyEvent - Interface in io.servicetalk.client.api: A hint from LoadBalancer.eventStream() that the internal state of the LoadBalancer is ready such LoadBalancer.selectConnection(Predicate, ContextMap) is not likely to fail.

N

newConnection(ResolvedAddress, TransportObserver) - Method in interface ConnectionFactory: Deprecated.
Use ConnectionFactory.newConnection(Object, ContextMap, TransportObserver).
newConnection(ResolvedAddress, ContextMap, TransportObserver) - Method in interface ConnectionFactory: Creates and asynchronously returns a connection.
newConnection(ResolvedAddress, TransportObserver) - Method in class DelegatingConnectionFactory: Deprecated.
newConnection(ResolvedAddress, ContextMap, TransportObserver) - Method in class DelegatingConnectionFactory
newConnection() - Method in interface LoadBalancedAddress: Deprecated.
Implement and use LoadBalancedAddress.newConnection(ContextMap).
newConnection(ContextMap) - Method in interface LoadBalancedAddress: Creates and asynchronously returns a connection for this address.
newConnection(ContextMap) - Method in interface LoadBalancer: Opens a new connection for a request instead of potentially reusing one.
newConnectionRefusedException(ResolvedAddress) - Method in interface LimitingConnectionFactoryFilter.ConnectionLimiter: Create a Throwable representing a connection attempt refused, typically as a result of returning false from LimitingConnectionFactoryFilter.ConnectionLimiter.isConnectAllowed(Object).
newKey(String) - Static method in class PartitionAttributes.Key: Deprecated.

Create a new PartitionAttributes.Key which has a String used only in the PartitionAttributes.Key.toString() method for debugging visibility.
newKey() - Static method in class PartitionAttributes.Key: Deprecated.

Create a new instance.
newLoadBalancer(Publisher<? extends ServiceDiscovererEvent<ResolvedAddress>>, ConnectionFactory<ResolvedAddress, T>) - Method in interface LoadBalancerFactory: Deprecated.
Use LoadBalancerFactory.newLoadBalancer(Publisher, ConnectionFactory, String).
newLoadBalancer(String, Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>>, ConnectionFactory<ResolvedAddress, T>) - Method in interface LoadBalancerFactory: Deprecated.
Use LoadBalancerFactory.newLoadBalancer(Publisher, ConnectionFactory, String).
newLoadBalancer(Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>>, ConnectionFactory<ResolvedAddress, C>, String) - Method in interface LoadBalancerFactory: Create a new LoadBalancer.
newPartitionMap(Function<PartitionAttributes, T>) - Method in interface PartitionMapFactory: Deprecated.

Create a new PartitionMap object.
NoActiveHostException - Exception in io.servicetalk.client.api: Thrown when no host is active to establish a new connection.
NoActiveHostException(String) - Constructor for exception NoActiveHostException: Creates a new instance.
NoAvailableHostException - Exception in io.servicetalk.client.api: Thrown when no host is available but at least one is required.
NoAvailableHostException(String) - Constructor for exception NoAvailableHostException: Creates a new instance.

O

of(String) - Static method in class ServiceDiscovererEvent.Status: Returns an ServiceDiscovererEvent.Status for the specified name.
onClose() - Method in class DelegatingConnectionFactory
onClose() - Method in class DelegatingServiceDiscoverer
onClosing() - Method in class DelegatingConnectionFactory
onClosing() - Method in class DelegatingServiceDiscoverer
onConnectionClose(ResolvedAddress) - Method in interface LimitingConnectionFactoryFilter.ConnectionLimiter: Callback invoked when a connection created after getting permission from LimitingConnectionFactoryFilter.ConnectionLimiter.isConnectAllowed(Object) is closed.

P

partitionAddress() - Method in interface PartitionedServiceDiscovererEvent: Deprecated.

Get the fully specified PartitionAttributes that uniquely identifies ServiceDiscovererEvent.address().
PartitionAttributes - Interface in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
PartitionAttributes.Key<T> - Class in io.servicetalk.client.api.partition: Deprecated.

A key identifies a specific object in a PartitionAttributes.
PartitionAttributesBuilder - Interface in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
PartitionedServiceDiscovererEvent<ResolvedAddress> - Interface in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
PartitionMap<T extends AsyncCloseable> - Interface in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
PartitionMapFactory - Interface in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.

R

releaseAsync() - Method in interface LoadBalancedConnection
releaseAsync() - Method in interface ReservableRequestConcurrencyController: Must be called (and subscribed to) to signify the reservation has completed after ReservableRequestConcurrencyController.tryReserve().
remove(PartitionAttributes) - Method in interface PartitionMap: Deprecated.

Remove a PartitionAttributes that was previously added via PartitionMap.add(PartitionAttributes).
RequestConcurrencyController - Interface in io.servicetalk.client.api: An interface which allows controlling reserving connections which maybe used concurrently.
RequestConcurrencyController.Result - Enum in io.servicetalk.client.api: Result of the RequestConcurrencyController.tryRequest() call.
requestFinished() - Method in interface LoadBalancedConnection
requestFinished() - Method in interface RequestConcurrencyController: Must be called after RequestConcurrencyController.tryRequest() to signify the request has completed.
RequestRejectedException - Exception in io.servicetalk.client.api: Thrown when a request was rejected before processing by the transport layer.
RequestRejectedException(String) - Constructor for exception RequestRejectedException: Creates a new instance.
RequestRejectedException(String, Throwable) - Constructor for exception RequestRejectedException: Creates a new instance.
requiredOffloads() - Method in interface ConnectionFactoryFilter
requiredOffloads() - Method in class DelegatingConnectionFactoryFilter
requiredOffloads() - Method in class LimitingConnectionFactoryFilter
requiredOffloads() - Method in interface LoadBalancerFactory
requiredOffloads() - Method in class TransportObserverConnectionFactoryFilter
ReservableRequestConcurrencyController - Interface in io.servicetalk.client.api: A RequestConcurrencyController that also allows to ReservableRequestConcurrencyController.tryReserve() a connection for exclusive use.
RetryableConnectException - Exception in io.servicetalk.client.api: Throws when a connect operations failed.
RetryableConnectException(String) - Constructor for exception RetryableConnectException: New instance.
RetryableConnectException(ConnectException) - Constructor for exception RetryableConnectException: Create a new instance.

S

score() - Method in interface ScoreSupplier: Returns the current score of a resource.
ScoreSupplier - Interface in io.servicetalk.client.api: Enables components to expose a score.
selectConnection(Predicate<C>) - Method in interface LoadBalancer: Deprecated.
Use LoadBalancer.selectConnection(Predicate, ContextMap).
selectConnection(Predicate<C>, ContextMap) - Method in interface LoadBalancer: Select the most appropriate connection for a request.
ServiceDiscoverer<UnresolvedAddress,ResolvedAddress,E extends ServiceDiscovererEvent<ResolvedAddress>> - Interface in io.servicetalk.client.api: Represents the interaction pattern with a service discovery system.
ServiceDiscovererEvent<ResolvedAddress> - Interface in io.servicetalk.client.api: Notification from the Service Discovery system that availability for an address has changed.
ServiceDiscovererEvent.Status - Class in io.servicetalk.client.api: Status provided by the ServiceDiscoverer system that guides the actions of LoadBalancer upon the bound ServiceDiscovererEvent.address() (via ServiceDiscovererEvent).
size() - Method in interface PartitionAttributes: Deprecated.

Determine how many key/value pairs are contained in this collection.
status() - Method in class DefaultServiceDiscovererEvent
status() - Method in interface ServiceDiscovererEvent: Status of the event instructing the ServiceDiscoverer what actions to take upon the associated address.

T

throwable() - Method in interface DelayedRetryException: Returns original Throwable this DelayedRetryException represents.
toString() - Method in class DefaultServiceDiscovererEvent
toString() - Method in class DelegatingServiceDiscoverer
toString() - Method in class PartitionAttributes.Key: Deprecated.
toString() - Method in class ServiceDiscovererEvent.Status
TransportObserverConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable> - Class in io.servicetalk.client.api: A ConnectionFactoryFilter that configures a TransportObserver for new connections.
TransportObserverConnectionFactoryFilter(TransportObserver) - Constructor for class TransportObserverConnectionFactoryFilter: Creates a new instance.
TransportObserverConnectionFactoryFilter(Function<ResolvedAddress, TransportObserver>) - Constructor for class TransportObserverConnectionFactoryFilter: Creates a new instance.
tryRequest() - Method in interface LoadBalancedConnection
tryRequest() - Method in interface RequestConcurrencyController: Attempts to reserve a connection for a single request, needs to be followed by RequestConcurrencyController.requestFinished().
tryReserve() - Method in interface LoadBalancedConnection
tryReserve() - Method in interface ReservableRequestConcurrencyController: Attempts to reserve a connection for exclusive use until ReservableRequestConcurrencyController.releaseAsync() is called.

U

UNAVAILABLE - Static variable in class ServiceDiscovererEvent.Status: Signifies the ServiceDiscovererEvent.address() is not available for use and all currently established connections should be closed.
UnknownPartitionException - Exception in io.servicetalk.client.api.partition: Deprecated.
We are unaware of anyone using "partition" feature and plan to remove it in future releases. If you depend on it, consider using ClientGroup as an alternative or reach out to the maintainers describing the use-case.
UnknownPartitionException(PartitionAttributes, String) - Constructor for exception UnknownPartitionException: Deprecated.

Create a new instance.

V

valueOf(String) - Static method in enum RequestConcurrencyController.Result: Returns the enum constant of this type with the specified name.
values() - Static method in enum RequestConcurrencyController.Result: Returns an array containing the constants of this enum type, in the order they are declared.

W

weight(float) - Method in interface LoadBalancedAddress: Enables addresses scoring to be influenced by a weight factor.
with(LimitingConnectionFactoryFilter.ConnectionLimiter<A, C>) - Static method in class LimitingConnectionFactoryFilter: Create a new ConnectionFactory that limits the created connections using the passed LimitingConnectionFactoryFilter.ConnectionLimiter.
withMax(int) - Static method in class LimitingConnectionFactoryFilter: Create a new ConnectionFactory that only creates a maximum of maxConnections active connections.
withStrategy(ConnectionFactoryFilter<RA, C>, ExecutionStrategy) - Static method in interface ConnectionFactoryFilter: Wraps a connection factory filter to return a specific execution strategy.

A B C D E F G H I L N O P R S T U V W