Modifier and Type | Class and Description |
---|---|
class |
Timer
The
Timer acts as the main timing facility for various operations, for
example to track and time out requests if they run for too long or for rescheduling needs. |
Modifier and Type | Method and Description |
---|---|
CoreContext |
CoreContext.alternateAddress(Optional<String> alternateAddress)
Sets the alternate address on this context.
|
ClusterConfig |
Core.clusterConfig()
This API provides access to the current config that is published throughout the core.
|
ConfigurationProvider |
Core.configurationProvider()
Returns the attached configuration provider.
|
Stream<EndpointDiagnostics> |
Core.diagnostics() |
Mono<Void> |
Core.ensureServiceAt(NodeIdentifier identifier,
ServiceType serviceType,
int port,
Optional<String> bucket,
Optional<String> alternateAddress)
This method can be used by a caller to make sure a certain service is enabled at the given
target node.
|
void |
Core.initGlobalConfig()
Instructs the client to, if possible, load and initialize the global config.
|
void |
Core.openBucket(String name)
Attempts to open a bucket and fails the
Mono if there is a persistent error
as the reason. |
<R extends Response> |
Core.send(Request<R> request,
boolean registerForTimeout)
Sends a command into the core layer and allows to avoid timeout registration.
|
Mono<Void> |
Core.shutdown() |
Mono<Void> |
Core.shutdown(Duration timeout)
Shuts down this core and all associated, owned resources.
|
Modifier and Type | Interface and Description |
---|---|
interface |
InternalSpan
The
InternalSpan tracks the nitty gritty details of the request/response cycle inside the SDK. |
static interface |
LoggingEventConsumer.Logger
Generic logger interface.
|
class |
OrphanReporter |
class |
SimpleEventBus
This super simple event bus should be used in testing only to assert certain
events got pushed through.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ConfigurationProvider
The
ConfigurationProvider is responsible for grabbing, converting and managing
bucket and cluster configurations. |
Modifier and Type | Method and Description |
---|---|
void |
ClusterConfig.deleteBucketConfig(String bucketName) |
void |
ClusterConfig.deleteGlobalConfig() |
void |
ClusterConfig.setBucketConfig(BucketConfig config) |
void |
ClusterConfig.setGlobalConfig(GlobalConfig config) |
Modifier and Type | Class and Description |
---|---|
class |
KeyValueBucketRefresher
The
KeyValueBucketRefresher keeps configs up-to-date through the KV service. |
Modifier and Type | Class and Description |
---|---|
class |
HealthPinger
The
HealthPinger allows to "ping" individual services with real operations for their health. |
static class |
HealthPinger.PingTarget |
class |
WaitUntilReadyHelper
Helper class to perform the "wait until ready" logic.
|
Modifier and Type | Method and Description |
---|---|
static Mono<PingResult> |
HealthPinger.ping(Core core,
Optional<Duration> timeout,
RetryStrategy retryStrategy,
Set<ServiceType> serviceTypes,
Optional<String> reportId,
Optional<String> bucketName)
Performs a service ping against all or (if given) the services provided.
|
static CompletableFuture<Void> |
WaitUntilReadyHelper.waitUntilReady(Core core,
Set<ServiceType> serviceTypes,
Duration timeout,
ClusterState desiredState,
Optional<String> bucketName) |
Constructor and Description |
---|
DiagnosticsResult(Map<ServiceType,List<EndpointDiagnostics>> endpoints,
String sdk,
String id)
Creates the new diagnostics report.
|
EndpointDiagnostics(ServiceType type,
EndpointState state,
String local,
String remote,
Optional<String> namespace,
Optional<Long> lastActivityUs,
Optional<String> id) |
EndpointPingReport(ServiceType type,
String id,
String local,
String remote,
PingState state,
Optional<String> namespace,
Duration latency,
Optional<String> error) |
PingResult(Map<ServiceType,List<EndpointPingReport>> endpoints,
String sdk,
String id)
Creates the new ping report.
|
Modifier and Type | Method and Description |
---|---|
void |
BaseEndpoint.decrementOutstandingRequests()
Helper method to decrement outstanding requests, even if they haven't finished yet.
|
long |
BaseEndpoint.lastConnectedAt() |
void |
BaseEndpoint.markRequestCompletion()
Called from the event loop handlers to mark a request as being completed.
|
void |
BaseEndpoint.notifyChannelInactive()
This method is called from inside the channel to tell the endpoint hat it got inactive.
|
Modifier and Type | Class and Description |
---|---|
class |
OwnedSupplier<T>
A special supplier which allows the SDK to distinguish passed in suppliers vs.
|
Modifier and Type | Method and Description |
---|---|
default void |
Authenticator.applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
The authenticator gets the chance to attach the client certificate to the ssl context if needed.
|
default void |
Authenticator.authHttpRequest(ServiceType serviceType,
com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
Allows to add authentication credentials to the http request for the given service.
|
default void |
Authenticator.authKeyValueConnection(EndpointContext endpointContext,
com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
Allows the authenticator to add KV handlers during connection bootstrap to perform
authentication.
|
IoEnvironment |
IoEnvironment.Builder.build() |
LoggerConfig.Builder |
LoggerConfig.Builder.customLogger(LoggingEventConsumer.Logger customLogger)
Allows to specify a custom logger.
|
default boolean |
Authenticator.supportsNonTls()
If this authenticator supports non-encrypted connections.
|
default boolean |
Authenticator.supportsTls()
If this authenticator supports encrypted connections.
|
Constructor and Description |
---|
OwnedSupplier(T value) |
Modifier and Type | Class and Description |
---|---|
class |
DefaultErrorUtil |
class |
HttpStatusCodeException |
class |
IndexesNotReadyException |
class |
UnsupportedConfigMechanismException |
Modifier and Type | Method and Description |
---|---|
byte[] |
AnalyticsException.content() |
static List<ErrorCodeAndMessage> |
ErrorCodeAndMessage.fromJsonArray(byte[] jsonArray) |
boolean |
PreparedStatementFailureException.retryable() |
Modifier and Type | Class and Description |
---|---|
class |
ErrorMapLoadingHandler
This handler tries to load the KV Error Map in a best effort manner.
|
class |
FeatureNegotiatingHandler
The
FeatureNegotiatingHandler is responsible for sending the KV "hello" command
and to handshake enabled features on both sides. |
class |
SaslListMechanismsHandler
The
SaslListMechanismsHandler asks the server KV engine which SASL mechanism it supports. |
class |
SelectBucketHandler
The
SelectBucketHandler is responsible for, selecting the right
bucket on this KV connection. |
class |
ServerFeature
The
ServerFeature enum describes all the different negotiation modes
between the server and the SDK. |
Modifier and Type | Class and Description |
---|---|
class |
Mapper
Provides utilities for encoding and decoding JSON data.
|
Modifier and Type | Method and Description |
---|---|
RequestContext |
RequestContext.clientContext(Map<String,Object> clientContext)
Allows to set a custom payload for this request.
|
RequestContext |
RequestContext.dispatchLatency(long dispatchLatency)
Allows to set the dispatch duration of the request.
|
RequestContext |
RequestContext.encodeLatency(long encodeLatency) |
RequestContext |
RequestContext.incrementRetryAttempts(Duration lastRetryDuration,
RetryReason reason) |
RequestContext |
RequestContext.lastChannelId(String lastChannelId) |
RequestContext |
RequestContext.lastDispatchedFrom(HostAndPort lastDispatchedFrom) |
RequestContext |
RequestContext.lastDispatchedTo(HostAndPort lastDispatchedTo) |
RequestContext |
RequestContext.logicallyComplete()
Signals that this request is completed fully, including streaming sections or logical sub-requests also being
completed (i.e.
|
RequestContext |
RequestContext.serverLatency(long serverLatency) |
Constructor and Description |
---|
RequestContext(CoreContext ctx,
Request<? extends Response> request)
Creates a new
RequestContext . |
Modifier and Type | Class and Description |
---|---|
class |
ExpiryUtils |
class |
SubDocumentField |
Modifier and Type | Method and Description |
---|---|
byte |
DurabilityLevel.code() |
Modifier and Type | Method and Description |
---|---|
void |
BucketConfigStreamingResponse.completeStream() |
void |
BucketConfigStreamingResponse.failStream(Throwable e) |
void |
BucketConfigStreamingResponse.pushConfig(String config) |
Modifier and Type | Class and Description |
---|---|
class |
FailFastRetryStrategy
An internal strategy to fail fast any request that goes through it.
|
class |
RetryOrchestrator
The
RetryOrchestrator is responsible for checking if a request is eligible for retry
and if so dispatch it properly and update state. |
Modifier and Type | Method and Description |
---|---|
static Duration |
RetryOrchestrator.capDuration(Duration uncappedDuration,
Request<? extends Response> request)
Calculates the potentially capped retry duration so we do not schedule a longer retry than the actual
total timeout.
|
Modifier and Type | Class and Description |
---|---|
class |
BucketConfigUtil
Defines helpful routines for working with bucket configs.
|
class |
CbAnnotations |
class |
CbCollections |
class |
CbObjects |
class |
CbStrings |
class |
CbThrowables |
static class |
ConnectionString.PortType |
class |
ConnectionStringUtil
Contains various helper methods when dealing with the connection string.
|
class |
DnsSrv |
class |
UrlQueryStringBuilder |
Copyright © 2020 Couchbase, Inc.. All rights reserved.