Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec 클래스 참조

더 자세히 ...

Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec에 대한 상속 다이어그램 :

Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec에 대한 협력 다이어그램:

클래스
class	FrameReadBuffer

Public 멤버 함수
	DelimiterMessageFrameCodec ()
	DelimiterMessageFrameCodec (string delimiter, Encoding encoding, int maxFrameLength)
async Task	WriteFrameAsync (Stream stream, byte[] payload, CancellationToken cancellationToken=default)
async Task< byte[]?>	ReadFrameAsync (Stream stream, CancellationToken cancellationToken=default)

Private 멤버 함수
bool	TryConsumeBufferedBytes (FrameReadBuffer readBuffer, List< byte > frame, out byte[]? result)
bool	EndsWithDelimiter (List< byte > frame)

Private 속성
readonly byte[]	_delimiter
readonly int	_maxFrameLength
readonly ConditionalWeakTable< Stream, FrameReadBuffer >	_readBuffers = new()

상세한 설명

지정한 바이트 구분자로 스트림의 메시지 경계를 구분합니다.

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

생성자 & 소멸자 문서화

DelimiterMessageFrameCodec() [1/2]

Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.DelimiterMessageFrameCodec ( )

inline

CRLF, UTF-8 및 1MiB 제한을 사용하는 코덱을 초기화합니다.

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

        : this("\r\n", Encoding.UTF8, 1024 * 1024)
    {
    }

DelimiterMessageFrameCodec() [2/2]

Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.DelimiterMessageFrameCodec ( string delimiter, Encoding encoding, int maxFrameLength )

inline

구분자, 인코딩 및 최대 프레임 길이를 지정하여 코덱을 초기화합니다.

매개변수

delimiter	메시지 끝을 표시할 문자열입니다.
encoding	구분자를 바이트로 변환할 인코딩입니다.
maxFrameLength	구분자를 제외한 최대 프레임 바이트 수입니다.

예외

ArgumentException	delimiter 가 비어 있는 경우 발생합니다.
ArgumentNullException	encoding 이 null인 경우 발생합니다.
ArgumentOutOfRangeException	maxFrameLength 가 0 이하인 경우 발생합니다.

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

    {
        ArgumentException.ThrowIfNullOrEmpty(delimiter);
        ArgumentNullException.ThrowIfNull(encoding);
 
        if (maxFrameLength <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(maxFrameLength));
        }
 
        _delimiter = encoding.GetBytes(delimiter);
        _maxFrameLength = maxFrameLength;
    }

다음을 참조함 : _delimiter, _maxFrameLength.

멤버 함수 문서화

EndsWithDelimiter()

bool Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.EndsWithDelimiter ( List< byte > frame )

inlineprivate

현재 프레임이 구성된 구분자 바이트로 끝나는지 확인합니다.

매개변수

frame

끝부분을 검사할 프레임입니다.

반환값

구분자로 끝나면 true입니다.

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

    {
        if (frame.Count < _delimiter.Length)
        {
            return false;
        }
 
        var start = frame.Count - _delimiter.Length;
 
        for (var index = 0; index < _delimiter.Length; index++)
        {
            if (frame[start + index] != _delimiter[index])
            {
                return false;
            }
        }
 
        return true;
    }

다음을 참조함 : _delimiter.

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

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

ReadFrameAsync()

async Task< byte[]?> Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.ReadFrameAsync ( Stream stream, CancellationToken cancellationToken = default )

inline

구분자까지의 바이트를 하나의 프레임으로 비동기 읽습니다.

매개변수

stream	읽을 스트림입니다.
cancellationToken	읽기 취소 요청을 감시하는 토큰입니다.

반환값

구분자를 제외한 프레임이며, 데이터 없이 스트림이 끝나면 null입니다.

예외

ArgumentNullException	stream 이 null인 경우 발생합니다.
InvalidDataException	프레임이 최대 길이를 초과한 경우 발생합니다.
OperationCanceledException	작업 취소가 요청된 경우 발생할 수 있습니다.

Dreamine.Communication.Core.Framing.IMessageFrameCodec를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(stream);
 
        var frame = new List<byte>(Math.Min(_maxFrameLength, 4096));
        var temp = new byte[Math.Min(_maxFrameLength, 4096)];
        var readBuffer = _readBuffers.GetValue(stream, _ => new FrameReadBuffer());
 
        while (true)
        {
            if (TryConsumeBufferedBytes(readBuffer, frame, out var frameBytes))
            {
                return frameBytes;
            }
 
            var read = await stream.ReadAsync(
                    temp.AsMemory(0, temp.Length),
                    cancellationToken)
                .ConfigureAwait(false);
 
            if (read == 0)
            {
                return frame.Count == 0
                    ? null
                    : frame.ToArray();
            }
 
            lock (readBuffer.SyncRoot)
            {
                for (var index = 0; index < read; index++)
                {
                    readBuffer.Pending.Enqueue(temp[index]);
                }
            }
        }
    }

다음을 참조함 : _maxFrameLength, _readBuffers, TryConsumeBufferedBytes().

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

TryConsumeBufferedBytes()

bool Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.TryConsumeBufferedBytes ( FrameReadBuffer readBuffer, List< byte > frame, out byte?[] result )

inlineprivate

스트림별 대기 버퍼의 바이트를 소비해 완전한 구분자 프레임 생성을 시도합니다.

매개변수

readBuffer	아직 처리하지 않은 바이트가 저장된 버퍼입니다.
frame	현재 조립 중인 프레임 바이트입니다.
result	완성된 경우 구분자를 제외한 프레임이며, 아니면 null입니다.

반환값

완전한 프레임을 만들었으면 true입니다.

예외

InvalidDataException

프레임이 최대 허용 길이를 초과한 경우 발생합니다.

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

    {
        result = null;
 
        lock (readBuffer.SyncRoot)
        {
            while (readBuffer.Pending.Count > 0)
            {
                frame.Add(readBuffer.Pending.Dequeue());
 
                if (frame.Count > _maxFrameLength)
                {
                    throw new InvalidDataException(
                        $"Frame length exceeded. MaxFrameLength={_maxFrameLength}");
                }
 
                if (!EndsWithDelimiter(frame))
                {
                    continue;
                }
 
                frame.RemoveRange(
                    frame.Count - _delimiter.Length,
                    _delimiter.Length);
 
                result = frame.ToArray();
                return true;
            }
        }
 
        return false;
    }

다음을 참조함 : _delimiter, _maxFrameLength, EndsWithDelimiter(), Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.FrameReadBuffer.Pending, Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.FrameReadBuffer.SyncRoot.

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

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

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

WriteFrameAsync()

async Task Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec.WriteFrameAsync ( Stream stream, byte[] payload, CancellationToken cancellationToken = default )

inline

페이로드와 구분자를 차례로 스트림에 비동기 기록합니다.

매개변수

stream	기록할 스트림입니다.
payload	구분자 앞에 기록할 메시지 데이터입니다.
cancellationToken	쓰기 취소 요청을 감시하는 토큰입니다.

반환값

비동기 프레임 쓰기 작업입니다.

예외

ArgumentNullException	스트림 또는 페이로드가 null인 경우 발생합니다.
OperationCanceledException	작업 취소가 요청된 경우 발생할 수 있습니다.

Dreamine.Communication.Core.Framing.IMessageFrameCodec를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(stream);
        ArgumentNullException.ThrowIfNull(payload);
 
        await stream.WriteAsync(payload, cancellationToken).ConfigureAwait(false);
        await stream.WriteAsync(_delimiter, cancellationToken).ConfigureAwait(false);
        await stream.FlushAsync(cancellationToken).ConfigureAwait(false);
    }

다음을 참조함 : _delimiter.

멤버 데이터 문서화

_delimiter

readonly byte [] Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec._delimiter

private

delimiter 값을 보관합니다.

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

다음에 의해서 참조됨 : DelimiterMessageFrameCodec(), EndsWithDelimiter(), TryConsumeBufferedBytes(), WriteFrameAsync().

_maxFrameLength

readonly int Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec._maxFrameLength

private

max Frame Length 값을 보관합니다.

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

다음에 의해서 참조됨 : DelimiterMessageFrameCodec(), ReadFrameAsync(), TryConsumeBufferedBytes().

_readBuffers

readonly ConditionalWeakTable<Stream, FrameReadBuffer> Dreamine.Communication.Core.Framing.DelimiterMessageFrameCodec._readBuffers = new()

private

read Buffers 값을 보관합니다.

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

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

---

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

• DelimiterMessageFrameCodec.cs