Interface IDataStoreStatusProvider

An interface for querying the status of a persistent data store.

Namespace: LaunchDarkly.Sdk.Server.Interfaces

Assembly: LaunchDarkly.ServerSdk.dll

Syntax

public interface IDataStoreStatusProvider

Remarks

An implementation of this interface is returned by DataStoreStatusProvider. Application code should not implement this interface.

Properties

Status

The current status of the store.

Declaration

DataStoreStatus Status { get; }

Property Value

Type	Description
DataStoreStatus

Remarks

This is only meaningful for persistent stores, or any other IDataStore implementation that makes use of the reporting mechanism provided by IDataStoreUpdates. For the default in-memory store, the status will always be reported as "available".

StatusMonitoringEnabled

Indicates whether the current data store implementation supports status monitoring.

Declaration

bool StatusMonitoringEnabled { get; }

Property Value

Type	Description
bool

Remarks

This is normally true for all persistent data stores, and false for the default in-memory store. A true value means that any status event listeners can expect to be notified if there is any error in storing data, and then notified again when the error condition is resolved. A false value means that the status is not meaningful and listeners should not expect to be notified.

Events

StatusChanged

An event for receiving notifications of status changes.

Declaration

event EventHandler<DataStoreStatus> StatusChanged

Event Type

Type	Description
EventHandler<DataStoreStatus>

Remarks

Any handlers attached to this event will be notified whenever any property of the status has changed. See DataStoreStatusfor an explanation of the meaning of each property and what could cause it to change.

Notifications will be dispatched on a background task. It is the listener's responsibility to return as soon as possible so as not to block subsequent notifications.