Dreamine.Logging.Sinks.AsyncQueueSink 클래스 참조

더 자세히 ...

Dreamine.Logging.Sinks.AsyncQueueSink에 대한 상속 다이어그램 :

Dreamine.Logging.Sinks.AsyncQueueSink에 대한 협력 다이어그램:

Public 멤버 함수
	AsyncQueueSink (IDreamineLogSink inner, int capacity=8192, int drainBatchSize=256)
void	Write (DreamineLogEntry entry)
async Task	ShutdownAsync (TimeSpan timeout)
async ValueTask	DisposeAsync ()
void	Dispose ()

속성
long	DroppedCount [get]

Private 멤버 함수
async Task	RunAsync ()

Private 속성
readonly IDreamineLogSink	_inner
readonly Channel< DreamineLogEntry >	_channel
readonly CancellationTokenSource	_cts = new()
readonly Task	_workerTask
readonly int	_drainBatchSize
long	_droppedCount
int	_disposed

상세한 설명

동기 로그 출력을 제한된 백그라운드 큐로 감쌉니다.

호출자는 비차단으로 항목을 큐에 넣고 단일 워커가 내부 출력으로 전달합니다. 큐가 차면 가장 오래된 항목을 버립니다.

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

생성자 & 소멸자 문서화

AsyncQueueSink()

Dreamine.Logging.Sinks.AsyncQueueSink.AsyncQueueSink ( IDreamineLogSink inner, int capacity = 8192, int drainBatchSize = 256 )

inline

내부 출력과 큐 설정으로 T:Dreamine.Logging.Sinks.AsyncQueueSink를 초기화합니다.

매개변수

inner	항목을 전달할 동기 출력입니다.
capacity	최대 대기 항목 수입니다.
drainBatchSize	내부 출력과 큐 설정으로 T:Dreamine.Logging.Sinks.AsyncQueueSink를 초기화합니다.

예외

ArgumentNullException	inner 가 null인 경우 발생합니다.
ArgumentOutOfRangeException	용량 또는 배치 크기가 0 이하인 경우 발생합니다.

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

        {
            _inner = inner ?? throw new ArgumentNullException(nameof(inner));
 
            if (capacity <= 0)
            {
                throw new ArgumentOutOfRangeException(nameof(capacity));
            }
 
            if (drainBatchSize <= 0)
            {
                throw new ArgumentOutOfRangeException(nameof(drainBatchSize));
            }
 
            _drainBatchSize = drainBatchSize;
 
            var options = new BoundedChannelOptions(capacity)
            {
                FullMode = BoundedChannelFullMode.DropOldest,
                SingleReader = true,
                SingleWriter = false,
                AllowSynchronousContinuations = false
            };
 
            _channel = Channel.CreateBounded<DreamineLogEntry>(options);
 
            _workerTask = Task.Factory.StartNew(
                RunAsync,
                CancellationToken.None,
                TaskCreationOptions.LongRunning,
                TaskScheduler.Default).Unwrap();
        }

다음을 참조함 : _channel, _drainBatchSize, _inner, _workerTask, RunAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

멤버 함수 문서화

Dispose()

void Dreamine.Logging.Sinks.AsyncQueueSink.Dispose ( )

inline

기본 제한 시간으로 큐를 동기 종료하고 오류를 억제합니다.

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

        {
            try
            {
                ShutdownAsync(TimeSpan.FromSeconds(2)).GetAwaiter().GetResult();
            }
            catch
            {
                // Suppress on dispose.
            }
        }

다음을 참조함 : ShutdownAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

DisposeAsync()

async ValueTask Dreamine.Logging.Sinks.AsyncQueueSink.DisposeAsync ( )

inline

기본 제한 시간으로 큐를 종료하고 리소스를 비동기 해제합니다.

반환값

비동기 해제 작업입니다.

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

        {
            await ShutdownAsync(TimeSpan.FromSeconds(2)).ConfigureAwait(false);
        }

다음을 참조함 : ShutdownAsync().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

RunAsync()

async Task Dreamine.Logging.Sinks.AsyncQueueSink.RunAsync ( )

inlineprivate

큐를 배치 단위로 비우고 내부 출력에 전달하는 전용 워커를 실행합니다.

반환값

워커 수명 작업입니다.

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

        {
            var reader = _channel.Reader;
            var batch = new List<DreamineLogEntry>(_drainBatchSize);
 
            try
            {
                while (await reader.WaitToReadAsync(_cts.Token).ConfigureAwait(false))
                {
                    batch.Clear();
 
                    while (batch.Count < _drainBatchSize && reader.TryRead(out var entry))
                    {
                        batch.Add(entry);
                    }
 
                    foreach (var item in batch)
                    {
                        try
                        {
                            _inner.Write(item);
                        }
                        catch
                        {
                            // Logging failure must not terminate the application.
                        }
                    }
                }
            }
            catch (OperationCanceledException)
            {
                // Expected on shutdown.
            }
            catch
            {
                // Defensive: never let the worker crash silently kill the channel.
            }
        }

다음을 참조함 : _channel, _cts, _drainBatchSize, _inner.

다음에 의해서 참조됨 : AsyncQueueSink().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

ShutdownAsync()

async Task Dreamine.Logging.Sinks.AsyncQueueSink.ShutdownAsync ( TimeSpan timeout )

inline

새 항목 수락을 중지하고 대기 항목이 처리될 때까지 기다립니다.

매개변수

timeout

워커 종료를 기다릴 최대 시간입니다.

반환값

비동기 종료 작업입니다.

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

        {
            if (Interlocked.Exchange(ref _disposed, 1) != 0)
            {
                return;
            }
 
            _channel.Writer.TryComplete();
 
            using var timeoutCts = new CancellationTokenSource(timeout);
            try
            {
                await _workerTask.WaitAsync(timeoutCts.Token).ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
                _cts.Cancel();
                try
                {
                    await _workerTask.ConfigureAwait(false);
                }
                catch
                {
                    // Suppress shutdown errors.
                }
            }
 
            // Best-effort dispose on the inner sink so file handles are closed.
            if (_inner is IAsyncDisposable asyncDisposable)
            {
                try
                {
                    await asyncDisposable.DisposeAsync().ConfigureAwait(false);
                }
                catch
                {
                    // Suppress on shutdown.
                }
            }
            else if (_inner is IDisposable disposable)
            {
                try
                {
                    disposable.Dispose();
                }
                catch
                {
                    // Suppress on shutdown.
                }
            }
 
            _cts.Dispose();
        }

다음을 참조함 : _channel, _cts, _disposed, _inner, _workerTask.

다음에 의해서 참조됨 : Dispose(), DisposeAsync().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

Write()

void Dreamine.Logging.Sinks.AsyncQueueSink.Write ( DreamineLogEntry entry )

inline

로그 항목을 비차단 방식으로 백그라운드 큐에 추가합니다.

매개변수

entry

추가할 로그 항목입니다.

예외

ArgumentNullException

entry 가 null인 경우 발생합니다.

로그 항목을 비차단 방식으로 백그라운드 큐에 추가합니다.

Dreamine.Logging.Interfaces.IDreamineLogSink를 구현.

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

        {
            ArgumentNullException.ThrowIfNull(entry);
 
            if (Volatile.Read(ref _disposed) != 0)
            {
                return;
            }
 
            // BoundedChannelFullMode.DropOldest guarantees TryWrite always succeeds
            // unless the channel is completed.
            if (!_channel.Writer.TryWrite(entry))
            {
                Interlocked.Increment(ref _droppedCount);
            }
        }

다음을 참조함 : _channel, _disposed, _droppedCount.

멤버 데이터 문서화

_channel

readonly Channel<DreamineLogEntry> Dreamine.Logging.Sinks.AsyncQueueSink._channel

private

channel 값을 보관합니다.

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

다음에 의해서 참조됨 : AsyncQueueSink(), RunAsync(), ShutdownAsync(), Write().

_cts

readonly CancellationTokenSource Dreamine.Logging.Sinks.AsyncQueueSink._cts = new()

private

cts 값을 보관합니다.

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

다음에 의해서 참조됨 : RunAsync(), ShutdownAsync().

_disposed

int Dreamine.Logging.Sinks.AsyncQueueSink._disposed

private

disposed 값을 보관합니다.

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

다음에 의해서 참조됨 : ShutdownAsync(), Write().

_drainBatchSize

readonly int Dreamine.Logging.Sinks.AsyncQueueSink._drainBatchSize

private

drain Batch Size 값을 보관합니다.

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

다음에 의해서 참조됨 : AsyncQueueSink(), RunAsync().

_droppedCount

long Dreamine.Logging.Sinks.AsyncQueueSink._droppedCount

private

dropped Count 값을 보관합니다.

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

다음에 의해서 참조됨 : Write().

_inner

readonly IDreamineLogSink Dreamine.Logging.Sinks.AsyncQueueSink._inner

private

inner 값을 보관합니다.

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

다음에 의해서 참조됨 : AsyncQueueSink(), RunAsync(), ShutdownAsync().

_workerTask

readonly Task Dreamine.Logging.Sinks.AsyncQueueSink._workerTask

private

worker Task 값을 보관합니다.

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

다음에 의해서 참조됨 : AsyncQueueSink(), ShutdownAsync().

속성 문서화

DroppedCount

long Dreamine.Logging.Sinks.AsyncQueueSink.DroppedCount

get

큐가 가득 차서 버려진 항목 수를 가져옵니다.

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

---

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

• AsyncQueueSink.cs