Skip to main content

ServerRuntime

Struct ServerRuntime 

Source
pub struct ServerRuntime { /* private fields */ }
Expand description

Standalone server runtime.

Implementations§

Source§

impl ServerRuntime

Source

pub fn new(config: ServerConfig) -> Result<Self, ServerConfigError>

Validate config and construct a runtime.

Source

pub fn with_cluster_status_provider( self, cluster_status: Arc<dyn ClusterStatusProvider>, ) -> Self

Override the cluster-status provider.

This is the W0 seam used by tests and later by the member-role grid host.

Source

pub fn with_observability_model( self, observability: ServerObservabilityModel, ) -> Self

Override additional read-only observability signals.

Source

pub fn start(self) -> Self

Start storage, cluster membership, listeners, and background services.

Source

pub fn health(&self) -> ServerHealth

Return liveness.

Source

pub fn ready(&self) -> ServerReadiness

Return readiness.

Source

pub fn can_serve(&self) -> bool

Return whether the runtime can serve traffic.

Source

pub fn is_draining(&self) -> bool

Return whether the runtime is currently draining.

Source

pub fn begin_request(&mut self) -> bool

Begin one in-flight request.

Source

pub fn finish_request(&mut self)

Complete one in-flight request.

Source

pub fn client_surface_ready(&self) -> bool

Return whether the external client surface is accepting work.

Source

pub fn begin_client_subscription(&self) -> bool

Begin a modeled client subscription stream.

Source

pub fn client_active_subscriptions(&self) -> u64

Return active modeled client subscription streams.

Source

pub fn client_surface_drain(&self) -> Option<ClientSurfaceDrain>

Return the last client-surface drain result, if the surface is enabled.

Source

pub fn redis_surface_ready(&self) -> bool

Return whether the optional Redis RESP surface is accepting work.

Source

pub fn begin_redis_connection(&mut self) -> bool

Begin a modeled RESP connection.

Source

pub fn finish_redis_connection(&mut self)

Finish a modeled RESP connection.

Source

pub fn redis_active_connections(&self) -> u64

Return active modeled RESP connections.

Source

pub fn redis_surface_drain(&self) -> Option<RedisSurfaceDrain>

Return the last Redis RESP surface drain result, if the surface is enabled.

Source

pub fn redis_listener_addr(&self) -> Option<SocketAddr>

Return the Redis RESP bind address when that optional listener is enabled.

Source

pub fn redis_resp_server( &self, ) -> Result<Option<RedisRespServer>, RedisServeError>

Build a Redis RESP executor using this runtime’s shared client-surface state.

Source

pub fn redis_tls_acceptor( &self, ) -> Result<Option<RedisTlsAcceptor>, RedisTlsError>

Build the optional Redis TLS acceptor when rediss:// is enabled.

Source

pub fn client_dispatch_state(&self) -> Option<Arc<ClientSurfaceState>>

Return the shared verified-dispatch state used by HC/1, RESP, and HC/2.

Source

pub fn diagnostic_reset_enabled(&self) -> bool

Return whether the local-only destructive diagnostic reset is enabled.

Source

pub fn diagnostic_reset_targets( &self, ) -> (HydraCache, Option<Arc<ClientSurfaceState>>)

Clone the owners cleared by the internal diagnostic reset route.

Source

pub fn begin_drain(&mut self)

Stop accepting new work and enter the draining state.

Source

pub fn request_admin_drain(&mut self) -> DrainOutcome

Accept an operator/admin drain request without stopping the daemon process.

Source

pub fn graceful_shutdown(&mut self) -> DrainOutcome

Gracefully stop accepting, drain, flush, and stop services.

Source

pub fn shutdown(&mut self) -> DrainOutcome

Backward-compatible alias for graceful shutdown.

Source

pub fn admin_status(&self) -> ServerAdminStatus

Return admin/operator status derived from the runtime model.

Source

pub fn raft_compaction_status( &self, ) -> Result<RaftCompactionStatus, RaftCompactionError>

Return current disk-backed Raft compaction progress without mutating it.

Source

pub fn request_raft_compaction( &self, ) -> Result<RaftCompactionStatus, ServerAdminActionError>

Explicitly compact the durable Raft log at current applied progress.

Source

pub fn metrics_registry(&self) -> HydraCacheRegistry

Build a metrics registry snapshot for the admin surface.

Source

pub fn cluster_overview(&self) -> ClusterOverview

Build a read-only Management Center cluster overview.

Source

pub fn request_reshard( &self, ) -> Result<ServerAdminAction, ServerAdminActionError>

Request an online reshard through the current runtime model.

Source

pub fn request_backup( &self, ) -> Result<ServerAdminAction, ServerAdminActionError>

Request a backup through the current runtime model.

Source

pub fn flushed(&self) -> bool

Return whether shutdown flushed durable state.

Source

pub fn cache(&self) -> &HydraCache

Return cache handle used by embedded tests/adapters.

Source

pub fn config(&self) -> &ServerConfig

Return the runtime config.

Trait Implementations§

Source§

impl Clone for ServerRuntime

Source§

fn clone(&self) -> ServerRuntime

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerRuntime

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more