Class CoreEnvironment
public class CoreEnvironment extends Object
Note that unless you are using the core directly, you want to consider the child implementations for each language binding (i.e. the ClusterEnvironment for the java client).
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CoreEnvironment.Builder<SELF extends CoreEnvironment.Builder<SELF>>
-
Field Summary
Fields Modifier and Type Field Description static long
DEFAULT_MAX_NUM_REQUESTS_IN_RETRY
Default maximum requests being queued in retry before performing backpressure cancellations. -
Constructor Summary
Constructors Modifier Constructor Description protected
CoreEnvironment(CoreEnvironment.Builder builder)
-
Method Summary
Modifier and Type Method Description static CoreEnvironment.Builder
builder()
Optional<String>
clientHash()
If present, returns the git hash for the client at build time.Optional<String>
clientVersion()
If present, returns the client version at build time.CompressionConfig
compressionConfig()
Returns the current compression configuration.Optional<String>
coreHash()
If present, returns the git hash for the core at build time.Optional<String>
coreVersion()
If present, returns the core version at build time.static CoreEnvironment
create()
protected String
defaultAgentTitle()
Returns the default user agent name that is used as part of the resulting string.EventBus
eventBus()
The central event bus which manages all kinds of messages flowing throughout the client.String
exportAsString(Context.ExportFormat format)
Export this environment into the specified format.IoConfig
ioConfig()
Returns the current configuration for all I/O-related settings.IoEnvironment
ioEnvironment()
Holds the environmental configuration/state that is tied to the IO layer.LoggerConfig
loggerConfig()
Returns the current logger configuration.long
maxNumRequestsInRetry()
Returns the maximum number of requests allowed in retry, before no more ops are allowed and canceled.Meter
meter()
OrphanReporter
orphanReporter()
Returns the orphan reporter on this environment.List<RequestCallback>
requestCallbacks()
RequestTracer
requestTracer()
Returns the request tracer for response time observability.RetryStrategy
retryStrategy()
Returns the retry strategy on this environment.Scheduler
scheduler()
Returns the scheduler used to schedule reactive, async tasks across the SDK.SecurityConfig
securityConfig()
Returns the current security configuration (TLS etc.).void
shutdown()
Shuts down this Environment with the default disconnect timeout.void
shutdown(Duration timeout)
Shuts down this Environment with a custom timeout.CompletableFuture<Void>
shutdownAsync()
Shuts down this Environment with the default disconnect timeout.CompletableFuture<Void>
shutdownAsync(Duration timeout)
Shuts down this Environment with a custom timeout.Mono<Void>
shutdownReactive()
Shuts down this Environment with the default disconnect timeout.Mono<Void>
shutdownReactive(Duration timeout)
Shuts down this Environment with a custom timeout.TimeoutConfig
timeoutConfig()
Returns the configuration for all default timeouts.Timer
timer()
Returns the timer used to schedule timeouts and retries amongst other tasks.String
toString()
UserAgent
userAgent()
User agent used to identify this client against the server.
-
Field Details
-
DEFAULT_MAX_NUM_REQUESTS_IN_RETRY
public static final long DEFAULT_MAX_NUM_REQUESTS_IN_RETRYDefault maximum requests being queued in retry before performing backpressure cancellations.- See Also:
- Constant Field Values
-
-
Constructor Details
-
CoreEnvironment
-
-
Method Details
-
create
-
builder
-
defaultAgentTitle
Returns the default user agent name that is used as part of the resulting string. -
clientHash
If present, returns the git hash for the client at build time. -
coreHash
If present, returns the git hash for the core at build time. -
clientVersion
If present, returns the client version at build time. -
coreVersion
If present, returns the core version at build time. -
userAgent
User agent used to identify this client against the server. -
eventBus
The central event bus which manages all kinds of messages flowing throughout the client.- Returns:
- the event bus currently in use.
-
ioEnvironment
Holds the environmental configuration/state that is tied to the IO layer. -
ioConfig
Returns the current configuration for all I/O-related settings. -
timeoutConfig
Returns the configuration for all default timeouts. -
securityConfig
Returns the current security configuration (TLS etc.). -
compressionConfig
Returns the current compression configuration. -
loggerConfig
Returns the current logger configuration. -
scheduler
Returns the scheduler used to schedule reactive, async tasks across the SDK. -
requestTracer
Returns the request tracer for response time observability.Note that this right now is unsupported, volatile API and subject to change!
-
meter
-
requestCallbacks
-
timer
Returns the timer used to schedule timeouts and retries amongst other tasks. -
retryStrategy
Returns the retry strategy on this environment. -
orphanReporter
Returns the orphan reporter on this environment. -
maxNumRequestsInRetry
public long maxNumRequestsInRetry()Returns the maximum number of requests allowed in retry, before no more ops are allowed and canceled. -
shutdownAsync
Shuts down this Environment with the default disconnect timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
-
shutdownAsync
Shuts down this Environment with a custom timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
- Parameters:
timeout
- the timeout to wait maximum.
-
shutdownReactive
Shuts down this Environment with the default disconnect timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
-
shutdownReactive
Shuts down this Environment with a custom timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
- Parameters:
timeout
- the timeout to wait maximum.
-
shutdown
Shuts down this Environment with a custom timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
- Parameters:
timeout
- the timeout to wait maximum.
-
shutdown
public void shutdown()Shuts down this Environment with the default disconnect timeout.Note that once shutdown, the environment cannot be restarted so it is advised to perform this operation at the very last operation in the SDK shutdown process.
-
exportAsString
Export this environment into the specified format.- Parameters:
format
- the format to export into.- Returns:
- the exported format as a string representation.
-
toString
-