Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue에 대한 상속 다이어그램 :

Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue에 대한 협력 다이어그램:

Public 멤버 함수
	InMemoryOutboundMessageQueue (OutboundQueueOptions? options=null)
ValueTask	EnqueueAsync (QueuedOutboundMessage message, CancellationToken cancellationToken=default)
ValueTask	EnqueueFrontAsync (QueuedOutboundMessage message, CancellationToken cancellationToken=default)
ValueTask< QueuedOutboundMessage?>	TryDequeueAsync (CancellationToken cancellationToken=default)
void	Clear ()

속성
int	Count `[get]`

Private 멤버 함수
void	EnsureCapacityForAddToBack ()
void	EnsureCapacityForAddToFront ()

Private 속성
readonly object	_sync = new()
readonly LinkedList< QueuedOutboundMessage >	_messages = new()
readonly OutboundQueueOptions	_options

상세한 설명

연결이 끊긴 동안 송신 대기 메시지를 메모리에 순서대로 보관합니다.

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

생성자 & 소멸자 문서화

◆ InMemoryOutboundMessageQueue()

Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.InMemoryOutboundMessageQueue ( OutboundQueueOptions? options = null )

inline

지정한 용량 및 초과 처리 설정으로 메모리 큐를 초기화합니다.

매개변수

options 큐 용량과 초과 처리 설정입니다. null이면 기본값을 사용합니다.

예외

ArgumentOutOfRangeException 최대 큐 크기가 0 이하인 경우 발생합니다.

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

    {
        _options = options ?? new OutboundQueueOptions();
 
        if (_options.MaxQueueSize <= 0)
        {
            throw new ArgumentOutOfRangeException(
                nameof(options),
                "MaxQueueSize must be greater than zero.");
        }
    }

다음을 참조함 : _options.

멤버 함수 문서화

◆ Clear()

void Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.Clear ( )

inline

큐에 저장된 모든 메시지를 스레드 안전하게 제거합니다.

Dreamine.Communication.Core.Queues.IOutboundMessageQueue를 구현.

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

    {
        lock (_sync)
        {
            _messages.Clear();
        }
    }

다음을 참조함 : _messages, _sync.

◆ EnqueueAsync()

ValueTask Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.EnqueueAsync	(	QueuedOutboundMessage	message,
		CancellationToken	cancellationToken = default )

inline

메시지를 큐 뒤쪽에 추가하며, 설정에 따라 가득 찬 큐의 가장 오래된 항목을 제거합니다.

매개변수

message	저장할 송신 대기 메시지입니다.
cancellationToken	추가 작업 취소 요청을 감시하는 토큰입니다.

반환값: 완료된 비동기 추가 작업입니다.

예외

ArgumentNullException	message 가 `null`인 경우 발생합니다.
InvalidOperationException	큐가 가득 찼고 오래된 메시지 제거가 비활성화된 경우 발생합니다.
OperationCanceledException	작업 취소가 요청된 경우 발생합니다.

Dreamine.Communication.Core.Queues.IOutboundMessageQueue를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(message);
        cancellationToken.ThrowIfCancellationRequested();
 
        lock (_sync)
        {
            EnsureCapacityForAddToBack();
            _messages.AddLast(message);
        }
 
        return ValueTask.CompletedTask;
    }

다음을 참조함 : _messages, _sync, EnsureCapacityForAddToBack().

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

◆ EnqueueFrontAsync()

ValueTask Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.EnqueueFrontAsync	(	QueuedOutboundMessage	message,
		CancellationToken	cancellationToken = default )

inline

재시도할 메시지를 큐 앞쪽에 다시 추가하며 필요하면 뒤쪽 항목을 제거합니다.

매개변수

message	큐 앞쪽에 다시 저장할 메시지입니다.
cancellationToken	추가 작업 취소 요청을 감시하는 토큰입니다.

반환값: 완료된 비동기 앞쪽 추가 작업입니다.

예외

ArgumentNullException	message 가 `null`인 경우 발생합니다.
InvalidOperationException	큐가 가득 찼고 오래된 메시지 제거가 비활성화된 경우 발생합니다.
OperationCanceledException	작업 취소가 요청된 경우 발생합니다.

Dreamine.Communication.Core.Queues.IOutboundMessageQueue를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(message);
        cancellationToken.ThrowIfCancellationRequested();
 
        lock (_sync)
        {
            EnsureCapacityForAddToFront();
            _messages.AddFirst(message);
        }
 
        return ValueTask.CompletedTask;
    }

다음을 참조함 : _messages, _sync, EnsureCapacityForAddToFront().

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

◆ EnsureCapacityForAddToBack()

void Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.EnsureCapacityForAddToBack ( )

inlineprivate

큐 뒤쪽에 항목을 추가할 공간을 확보하고 설정에 따라 가장 오래된 항목을 제거합니다.

예외

InvalidOperationException 큐가 가득 찼고 항목 제거가 비활성화된 경우 발생합니다.

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

    {
        if (_messages.Count < _options.MaxQueueSize)
        {
            return;
        }
 
        if (!_options.DropOldestWhenFull)
        {
            throw new InvalidOperationException("Outbound message queue is full.");
        }
 
        _messages.RemoveFirst();
    }

다음을 참조함 : _messages, _options.

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

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

◆ EnsureCapacityForAddToFront()

void Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.EnsureCapacityForAddToFront ( )

inlineprivate

큐 앞쪽에 항목을 추가할 공간을 확보하고 설정에 따라 가장 최근 항목을 제거합니다.

예외

InvalidOperationException 큐가 가득 찼고 항목 제거가 비활성화된 경우 발생합니다.

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

    {
        if (_messages.Count < _options.MaxQueueSize)
        {
            return;
        }
 
        if (!_options.DropOldestWhenFull)
        {
            throw new InvalidOperationException("Outbound message queue is full.");
        }
 
        _messages.RemoveLast();
    }

다음을 참조함 : _messages, _options.

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

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

◆ TryDequeueAsync()

ValueTask< QueuedOutboundMessage?> Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.TryDequeueAsync ( CancellationToken cancellationToken = default )

inline

큐에서 가장 오래된 메시지를 제거해 반환합니다.

매개변수

cancellationToken 꺼내기 작업 취소 요청을 감시하는 토큰입니다.

반환값: 제거한 메시지이며, 큐가 비어 있으면 null입니다.

예외

OperationCanceledException 작업 취소가 요청된 경우 발생합니다.

Dreamine.Communication.Core.Queues.IOutboundMessageQueue를 구현.

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

    {
        cancellationToken.ThrowIfCancellationRequested();
 
        lock (_sync)
        {
            if (_messages.First is null)
            {
                return ValueTask.FromResult<QueuedOutboundMessage?>(null);
            }
 
            var message = _messages.First.Value;
            _messages.RemoveFirst();
 
            return ValueTask.FromResult<QueuedOutboundMessage?>(message);
        }
    }

다음을 참조함 : _messages, _sync.

멤버 데이터 문서화

◆ _messages

readonly LinkedList<QueuedOutboundMessage> Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue._messages = new()

private

messages 값을 보관합니다.

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

다음에 의해서 참조됨 : Clear(), EnqueueAsync(), EnqueueFrontAsync(), EnsureCapacityForAddToBack(), EnsureCapacityForAddToFront(), TryDequeueAsync().

◆ _options

readonly OutboundQueueOptions Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue._options

private

options 값을 보관합니다.

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

다음에 의해서 참조됨 : EnsureCapacityForAddToBack(), EnsureCapacityForAddToFront(), InMemoryOutboundMessageQueue().

◆ _sync

readonly object Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue._sync = new()

private

sync 값을 보관합니다.

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

다음에 의해서 참조됨 : Clear(), EnqueueAsync(), EnqueueFrontAsync(), TryDequeueAsync().

속성 문서화

◆ Count

int Dreamine.Communication.Core.Queues.InMemoryOutboundMessageQueue.Count

get

현재 큐에 저장된 메시지 수를 스레드 안전하게 가져옵니다.

Dreamine.Communication.Core.Queues.IOutboundMessageQueue를 구현.

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

    {
        get
        {
            lock (_sync)
            {
                return _messages.Count;
            }
        }
    }

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

InMemoryOutboundMessageQueue.cs

Public 멤버 함수

속성

Private 멤버 함수

Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ InMemoryOutboundMessageQueue()

멤버 함수 문서화

◆ Clear()

◆ EnqueueAsync()

◆ EnqueueFrontAsync()

◆ EnsureCapacityForAddToBack()

◆ EnsureCapacityForAddToFront()

◆ TryDequeueAsync()

멤버 데이터 문서화

◆ _messages

◆ _options

◆ _sync

속성 문서화

◆ Count