Lockjaw.Core 2.0.2.62

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Lockjaw.Core --version 2.0.2.62
                    


                    

                
NuGet\Install-Package Lockjaw.Core -Version 2.0.2.62
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Lockjaw.Core" Version="2.0.2.62" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Lockjaw.Core" Version="2.0.2.62" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Lockjaw.Core" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Lockjaw.Core --version 2.0.2.62
                    


                    

                
#r "nuget: Lockjaw.Core, 2.0.2.62"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Lockjaw.Core@2.0.2.62
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Lockjaw.Core&version=2.0.2.62
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Lockjaw.Core&version=2.0.2.62
                    


                            Install as a Cake Tool

Lockjaw.Core

The shared model behind Lockjaw: it reads environment-prefixed settings from app.config and appsettings.json, resolves each key to the environment you have selected, and defines the snapshot the Lockjaw app publishes and clients read.

Most applications want Lockjaw.Client, not this package. Reference Lockjaw.Core directly only when you are hosting the resolution yourself or building tooling on top of Lockjaw.

netstandard2.0, with no UI dependency.

What it does

Keys are prefixed with the environment they belong to. Lockjaw groups the prefixed keys into one logical setting holding every environment's value:

<add key="Development_ApiUrl" value="https://localhost:5001/api" />
<add key="Production_ApiUrl"  value="https://api.contoso.com/v2" />

becomes a single ApiUrl entry that resolves to whichever environment is selected.

Hosting it yourself

using var host = new LockjawHost(new LockjawOptions
{
    InstanceName = "default",
    Environments =
    {
        new EnvironmentDefinition("Local", "Local_"),
        new EnvironmentDefinition("Test",  "Test_", "#7C3AED")
    },
    DefaultEnvironment = "Development"
}).Initialize();

var apiUrl = host.Catalog.Get("ApiUrl");
host.Catalog.SelectAll("Test");

Initialize() reads the configuration, layers on any saved edits, restores the remembered selections, and publishes a snapshot. Every later change republishes automatically.

Reload() re-reads the configuration files and rebuilds the catalog, keeping the user's edits and chosen environments — use it when a file has changed on disk. The sources are read in full before anything is discarded, so a file that has become unreadable throws and leaves the previous state exactly as it was.

The host also watches those files and raises ConfigurationChanged once they settle — debounced, because editors write a file in several steps. It reports rather than reloads, so the owner picks the moment; a UI reloads on its own thread, where rebuilding what is on screen is safe:

host.ConfigurationChanged += (s, e) => dispatcher.BeginInvoke(new Action(() => host.Reload()));

Turn it off with LockjawOptions.WatchConfigurationFiles, or change the settle time with WatchQuietPeriodMs.

Key types

Type Purpose
LockjawHost Loads configuration, persists edits and choices, publishes the snapshot
LockjawOptions Environments, prefixes, default environment, file locations, sources
SettingsCatalog The merged, prefix-stripped settings; selection and full editing API
SettingEntry One key with every environment's value, and the one in use
EnvironmentDefinition An environment: name, key prefix, optional color
ResolvedSnapshot / ResolvedSetting The published format clients read
SettingsTransfer / SettingsBundle Import and export
LocalConfigLoader Reads the current process's own config into a catalog
IConfigurationSource / InMemoryConfigSource Feed Lockjaw values from anywhere

Colon-delimited paths

JsonConfigSource flattens nested objects and arrays into colon paths, as .NET configuration does — { "Logging": { "Level": "Debug" } } becomes Logging:Level, and array items take their index. SettingsCatalog will strip an environment prefix from any segment of such a path, so either the whole subtree or a single leaf can carry it.

Environments are open-ended

Development_ and Production_ are only the defaults. Declare whatever you use — Local_, Test_, Staging_ — and Lockjaw picks those keys up. The longest matching prefix wins, so Test_ and Test_Local_ can coexist. A key with no value in the default environment falls back to the first declared environment it does have.

Editing

The catalog is editable, and edits never rewrite your configuration files — they are held as a diff and persisted separately, so config keeps its comments and every value can be reverted:

using (catalog.BeginEdit())          // one change notification for the batch
{
    catalog.SetValue("ApiUrl", SettingKind.AppSetting, "Local", "http://localhost:5000");
    catalog.SetValue("ApiUrl", SettingKind.AppSetting, "Test",  "https://test.contoso.com");
}

catalog.IsOverridden("ApiUrl", SettingKind.AppSetting, "Local");   // differs from config?
catalog.ConfigValue("ApiUrl", SettingKind.AppSetting, "Local");    // what config actually says
catalog.RevertValue("ApiUrl", SettingKind.AppSetting, "Local");    // put it back

Import and export

var bundle = SettingsTransfer.Export(catalog, "default", DateTime.UtcNow);
SettingsTransfer.Write(bundle, path);

var result = SettingsTransfer.Import(catalog, SettingsTransfer.Read(path),
    new ImportOptions { Mode = ImportMode.Merge });

Values naming an environment the target does not declare are skipped and reported rather than creating settings nothing can display.

Notes

  • Persistence is best effort: a locked or corrupt store costs the saved choices, never the host app.
  • A malformed configuration section makes .NET throw while parsing it; local-config reads treat that as "no values" rather than crashing.
  • LockjawHost is IDisposable — disposing saves edits and selections.

See also

  • Lockjaw.Client — what applications reference to read the resolved values.
  • The Lockjaw app — the tray UI over this model.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Lockjaw.Core:

Package Downloads
Lockjaw.Client

Read the environment currently selected in the Lockjaw app from any .NET application, and react the moment it changes. Lockjaw keeps every environment's values in one configuration — keys prefixed Development_, Production_, or whatever else you declare — and lets you choose, per setting and while your app is running, which one each resolves to. Ask for the key without its prefix and you get the selected value; no configuration needed on your side. Values update live, stay readable when the Lockjaw app is not running, and fall back to the consuming application's own app.config or appsettings.json when nothing has been published. Includes a UI-thread marshalling helper for WPF and WinForms.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.2.73 94 8/14/2026
2.0.2.72 94 8/14/2026
2.0.2.62 122 8/6/2026
2.0.2.61 87 8/6/2026
2.0.2.59 126 8/5/2026
2.0.2.58 115 8/5/2026
2.0.2.57 109 8/5/2026
2.0.2.50 121 8/5/2026
2.0.2.49 125 8/5/2026
2.0.2.28 144 7/25/2026

2.2.0
- Connection strings now carry their providerName through the whole pipeline: SettingEntry.ProviderName and GetProviderName(environment) expose it per environment, and ResolvedSetting.ProviderName publishes it to clients. Read from the providerName attribute in app.config, and in JSON from an object form — "Main": { "connectionString": "…", "providerName": "…" }. Snapshots written before this field existed still read, reporting an empty provider.
- The providerName is editable and persists like any other edit: SettingsCatalog.SetValue takes one, IsOverridden and Revert account for it, and it travels in exported bundles. An edit that says nothing about the provider leaves the configured one in place, so overlays and bundles written before this release never clear a provider. ConfigProviderName reports what the configuration files declared.
- The snapshot push now travels over SIPC, a semaphore-only peer mesh, instead of a named pipe. LockjawHost joins the instance's mesh and publishes each republished snapshot to a channel its clients subscribe to. No sockets, pipes or shared files are used, so live updates keep working where those are locked down. The snapshot file is still written; the push is added on top. Controlled by LockjawOptions.BroadcastChanges (on by default).
- Requires SIPC 0.3.0+, whose channels are strongly consistent: once a client has subscribed, every later publish is guaranteed to reach it, so a selection change never silently stops reaching a client. Per-word send timeouts are bounded so a client killed without disposing (a debugger stop) cannot stall delivery to the others.
- LockjawHost.Suspend()/Resume() clear and restore publishing, so a host can behave as if no app is present and its clients fall back to their own configuration.
- LockjawOptions.AllowCrossAccountClients now places the mesh's semaphores in the global namespace so a client in another session or under a different Windows account can join (off by default); that namespace may require privilege and the client must opt in to match it. Same-user clients on the same desktop work without it.

2.1.0
- LockjawHost now pushes each republished snapshot to connected clients over a named pipe, so a selection change reaches them at once instead of relying on them noticing the snapshot file change — which a locked-down machine can silently prevent. The snapshot file is still written; the push is added on top. Controlled by LockjawOptions.BroadcastChanges (on by default).
- LockjawOptions.AllowCrossAccountClients widens the pipe's ACL so a client under a different Windows account can receive pushes (off by default). Same-user clients, including in another logon session, work without it.

2.0.2
- Environments are open-ended and declared by name + prefix, replacing the fixed Development/Production enum.
- Full editing API on SettingsCatalog: set, clear, rename, delete, revert, with batched change notification.
- Edits persist as a diff against the configuration files, so config is never rewritten and any value can be reverted.
- Import and export via SettingsTransfer, with merge and replace modes.
- The published snapshot now carries the environment list, including colors and the default.