FamiliesApp.Services.JsonGlobalSettingsStore 클래스 참조

FamiliesApp.Services.JsonGlobalSettingsStore에 대한 상속 다이어그램 :

FamiliesApp.Services.JsonGlobalSettingsStore에 대한 협력 다이어그램:

Public 멤버 함수
	JsonGlobalSettingsStore (FamilyOptions opts)
async Task< GlobalSettings >	GetAsync (CancellationToken ct=default)
async Task	SaveAsync (GlobalSettings settings, CancellationToken ct=default)

Private 속성
readonly string	_path
GlobalSettings?	_cache

정적 Private 속성
static readonly SemaphoreSlim	_gate = new(1, 1)
static readonly JsonSerializerOptions	_jsonOpts = new() { WriteIndented = true }

상세한 설명

JsonGlobalSettingsStore.cs 파일의 15 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

JsonGlobalSettingsStore()

FamiliesApp.Services.JsonGlobalSettingsStore.JsonGlobalSettingsStore ( FamilyOptions opts )

inline

지정한 설정으로 JsonGlobalSettingsStore 클래스의 새 인스턴스를 초기화합니다.

매개변수

opts	opts에 사용할 FamilyOptions 값입니다.

JsonGlobalSettingsStore.cs 파일의 71 번째 라인에서 정의되었습니다.

    {
        var dataRoot = Path.GetDirectoryName(opts.ResolvedDataPath.TrimEnd(Path.DirectorySeparatorChar))
            ?? Path.Combine(AppContext.BaseDirectory, "App_Data");
        Directory.CreateDirectory(dataRoot);
        _path = Path.Combine(dataRoot, "global-settings.json");
    }

다음을 참조함 : _path, FamiliesApp.Services.FamilyOptions.ResolvedDataPath.

멤버 함수 문서화

GetAsync()

async Task< GlobalSettings > FamiliesApp.Services.JsonGlobalSettingsStore.GetAsync ( CancellationToken ct = default )

inline

Async 값을 가져옵니다.

매개변수

ct	취소 요청을 감시하는 토큰입니다.

반환값

Get Async 작업에서 생성한 Task<GlobalSettings> 결과입니다.

FamiliesApp.Services.IGlobalSettingsStore를 구현.

JsonGlobalSettingsStore.cs 파일의 103 번째 라인에서 정의되었습니다.

    {
        if (_cache is not null) return _cache;
 
        await _gate.WaitAsync(ct).ConfigureAwait(false);
        try
        {
            if (_cache is not null) return _cache;
 
            if (!File.Exists(_path))
            {
                _cache = new GlobalSettings();
                return _cache;
            }
 
            await using var fs = File.OpenRead(_path);
            _cache = await JsonSerializer.DeserializeAsync<GlobalSettings>(fs, _jsonOpts, ct).ConfigureAwait(false)
                ?? new GlobalSettings();
            return _cache;
        }
        finally { _gate.Release(); }
    }

다음을 참조함 : _cache, _gate, _jsonOpts, _path.

SaveAsync()

async Task FamiliesApp.Services.JsonGlobalSettingsStore.SaveAsync ( GlobalSettings settings, CancellationToken ct = default )

inline

Async 데이터를 저장합니다.

매개변수

settings	settings에 사용할 GlobalSettings 값입니다.
ct	취소 요청을 감시하는 토큰입니다.

반환값

Save Async 작업에서 생성한 Task 결과입니다.

FamiliesApp.Services.IGlobalSettingsStore를 구현.

JsonGlobalSettingsStore.cs 파일의 158 번째 라인에서 정의되었습니다.

    {
        await _gate.WaitAsync(ct).ConfigureAwait(false);
        try
        {
            var tmp = _path + ".tmp";
            await using (var fs = File.Create(tmp))
                await JsonSerializer.SerializeAsync(fs, settings, _jsonOpts, ct).ConfigureAwait(false);
 
            File.Copy(tmp, _path, overwrite: true);
            File.Delete(tmp);
            _cache = settings;
        }
        finally { _gate.Release(); }
    }

다음을 참조함 : _cache, _gate, _jsonOpts, _path.

멤버 데이터 문서화

_cache

GlobalSettings? FamiliesApp.Services.JsonGlobalSettingsStore._cache

private

cache 값을 보관합니다.

JsonGlobalSettingsStore.cs 파일의 43 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetAsync(), SaveAsync().

_gate

readonly SemaphoreSlim FamiliesApp.Services.JsonGlobalSettingsStore._gate = new(1, 1)

staticprivate

gate 값을 보관합니다.

JsonGlobalSettingsStore.cs 파일의 34 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetAsync(), SaveAsync().

_jsonOpts

readonly JsonSerializerOptions FamiliesApp.Services.JsonGlobalSettingsStore._jsonOpts = new() { WriteIndented = true }

staticprivate

json Opts 값을 보관합니다.

JsonGlobalSettingsStore.cs 파일의 53 번째 라인에서 정의되었습니다.

{ WriteIndented = true };

다음에 의해서 참조됨 : GetAsync(), SaveAsync().

_path

readonly string FamiliesApp.Services.JsonGlobalSettingsStore._path

private

path 값을 보관합니다.

JsonGlobalSettingsStore.cs 파일의 25 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetAsync(), JsonGlobalSettingsStore(), SaveAsync().

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• JsonGlobalSettingsStore.cs