Dreamine.Communication.Serial.Ports.SerialPortTransport에 대한 상속 다이어그램 :

Dreamine.Communication.Serial.Ports.SerialPortTransport에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
	SerialPortTransport (SerialPortTransportOptions options)
	SerialPortTransport (SerialPortTransportOptions options, IMessageProtocolAdapter protocolAdapter, IMessageFrameCodec frameCodec)
Task	ConnectAsync (CancellationToken cancellationToken=default)
async Task	DisconnectAsync (CancellationToken cancellationToken=default)
async Task	SendAsync (MessageEnvelope message, CancellationToken cancellationToken=default)
async ValueTask	DisposeAsync ()

속성
ConnectionState	State `[get]`
TransportKind	Kind `[get]`

이벤트
EventHandler< MessageEnvelope >?	MessageReceived

Private 멤버 함수
async Task	ReceiveLoopAsync (CancellationToken cancellationToken)
void	CleanupSerialPort ()
void	SetState (ConnectionState state)

정적 Private 멤버 함수
static void	ValidateOptions (SerialPortTransportOptions options)

Private 속성
readonly SerialPortTransportOptions	_options
readonly IMessageProtocolAdapter	_protocolAdapter
readonly IMessageFrameCodec	_frameCodec
SerialPort?	_serialPort
CancellationTokenSource?	_receiveLoopCts
Task?	_receiveLoopTask
int	_state = (int)ConnectionState.Disconnected

상세한 설명

.NET T:System.IO.Ports.SerialPort와 구성 가능한 프레임·프로토콜 어댑터를 사용하는 RS-232 메시지 전송 계층입니다.

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

생성자 & 소멸자 문서화

◆ SerialPortTransport() [1/2]

Dreamine.Communication.Serial.Ports.SerialPortTransport.SerialPortTransport ( SerialPortTransportOptions options )

inline

기본 Dreamine JSON 프로토콜과 길이 접두사 프레임으로 전송 계층을 초기화합니다.

매개변수

options 시리얼 회선 및 버퍼 설정입니다.

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

        : this(
            options,
            new DreamineEnvelopeProtocolAdapter(),
            new LengthPrefixedMessageFrameCodec())
    {
    }

◆ SerialPortTransport() [2/2]

Dreamine.Communication.Serial.Ports.SerialPortTransport.SerialPortTransport	(	SerialPortTransportOptions	options,
		IMessageProtocolAdapter	protocolAdapter,
		IMessageFrameCodec	frameCodec )

inline

시리얼 설정과 사용자 지정 프로토콜 및 프레임 코덱으로 전송 계층을 초기화합니다.

매개변수

options	시리얼 회선 및 버퍼 설정입니다.
protocolAdapter	메시지와 외부 페이로드를 변환할 어댑터입니다.
frameCodec	스트림의 메시지 경계를 처리할 코덱입니다.

예외

ArgumentNullException options , protocolAdapter 또는 frameCodec 이 null인 경우 발생합니다.

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

    {
        _options = options ?? throw new ArgumentNullException(nameof(options));
        _protocolAdapter = protocolAdapter ?? throw new ArgumentNullException(nameof(protocolAdapter));
        _frameCodec = frameCodec ?? throw new ArgumentNullException(nameof(frameCodec));
 
        ValidateOptions(_options);
    }

다음을 참조함 : _frameCodec, _options, _protocolAdapter, ValidateOptions().

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

멤버 함수 문서화

◆ CleanupSerialPort()

void Dreamine.Communication.Serial.Ports.SerialPortTransport.CleanupSerialPort ( )

inlineprivate

예외를 외부로 전파하지 않고 시리얼 포트를 닫고 해제합니다.

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

    {
        try
        {
            if (_serialPort is not null && _serialPort.IsOpen)
            {
                _serialPort.Close();
            }
        }
        catch
        {
        }
 
        try
        {
            _serialPort?.Dispose();
        }
        catch
        {
        }
 
        _serialPort = null;
    }

다음을 참조함 : _serialPort.

다음에 의해서 참조됨 : ReceiveLoopAsync(), SendAsync().

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

◆ ConnectAsync()

Task Dreamine.Communication.Serial.Ports.SerialPortTransport.ConnectAsync ( CancellationToken cancellationToken = default )

inline

시리얼 포트를 열고 백그라운드 수신 루프를 시작합니다. 포트 열기 자체는 동기 API입니다.

매개변수

cancellationToken 포트를 열기 전 취소 요청을 확인하는 토큰입니다.

반환값: 연결 시작 작업입니다.

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

    {
        if (State is ConnectionState.Connected or ConnectionState.Connecting)
        {
            return Task.CompletedTask;
        }
 
        cancellationToken.ThrowIfCancellationRequested();
 
        SetState(ConnectionState.Connecting);
 
        try
        {
            _serialPort = new SerialPort(
                _options.PortName,
                _options.BaudRate,
                _options.Parity,
                _options.DataBits,
                _options.StopBits)
            {
                Handshake = _options.Handshake,
                ReadTimeout = _options.ReadTimeoutMs,
                WriteTimeout = _options.WriteTimeoutMs,
                ReadBufferSize = _options.ReadBufferSize,
                WriteBufferSize = _options.WriteBufferSize
            };
 
            _serialPort.Open();
 
            SetState(ConnectionState.Connected);
 
            _receiveLoopCts = new CancellationTokenSource();
            _receiveLoopTask = Task.Run(
                () => ReceiveLoopAsync(_receiveLoopCts.Token),
                _receiveLoopCts.Token);
 
            return Task.CompletedTask;
        }
        catch
        {
            SetState(ConnectionState.Faulted);
 
            _serialPort?.Dispose();
            _serialPort = null;
 
            throw;
        }
    }

다음을 참조함 : _options, _receiveLoopCts, _receiveLoopTask, _serialPort, ReceiveLoopAsync(), SetState(), State.

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

◆ DisconnectAsync()

async Task Dreamine.Communication.Serial.Ports.SerialPortTransport.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

수신 루프를 중지하고 시리얼 포트와 관련 리소스를 닫습니다.

매개변수

cancellationToken 정리 후 연결 해제 취소 여부를 확인하는 토큰입니다.

반환값: 비동기 연결 해제 작업입니다.

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

    {
        if (State == ConnectionState.Disconnected)
        {
            return;
        }
 
        SetState(ConnectionState.Disconnecting);
 
        _receiveLoopCts?.Cancel();
 
        if (_serialPort is not null)
        {
            try
            {
                if (_serialPort.IsOpen)
                {
                    _serialPort.Close();
                }
            }
            finally
            {
                _serialPort.Dispose();
            }
        }
 
        if (_receiveLoopTask is not null)
        {
            try
            {
                await _receiveLoopTask.ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
            }
            catch (ObjectDisposedException)
            {
            }
            catch (InvalidOperationException)
            {
            }
            catch (IOException)
            {
            }
        }
 
        _receiveLoopCts?.Dispose();
        _receiveLoopCts = null;
        _receiveLoopTask = null;
        _serialPort = null;
 
        cancellationToken.ThrowIfCancellationRequested();
 
        SetState(ConnectionState.Disconnected);
    }

다음을 참조함 : _receiveLoopCts, _receiveLoopTask, _serialPort, SetState(), State.

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.Communication.Serial.Ports.SerialPortTransport.DisposeAsync ( )

inline

시리얼 포트 연결과 수신 루프 리소스를 비동기적으로 해제합니다.

반환값: 비동기 리소스 해제 작업입니다.

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

    {
        await DisconnectAsync().ConfigureAwait(false);
    }

다음을 참조함 : DisconnectAsync().

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

◆ ReceiveLoopAsync()

async Task Dreamine.Communication.Serial.Ports.SerialPortTransport.ReceiveLoopAsync ( CancellationToken cancellationToken )

inlineprivate

시리얼 스트림에서 프레임을 계속 읽어 메시지로 디코딩하고 수신 이벤트를 발생시킵니다.

매개변수

cancellationToken 수신 루프 종료를 요청하는 토큰입니다.

반환값: 백그라운드 수신 루프 작업입니다.

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

    {
        if (_serialPort is null)
        {
            return;
        }
 
        try
        {
            while (!cancellationToken.IsCancellationRequested &&
                   State == ConnectionState.Connected)
            {
                var payload = await _frameCodec.ReadFrameAsync(
                        _serialPort.BaseStream,
                        cancellationToken)
                    .ConfigureAwait(false);
 
                if (payload is null)
                {
                    break;
                }
 
                var message = _protocolAdapter.Decode(payload);
                MessageReceived?.Invoke(this, message);
            }
 
            if (!cancellationToken.IsCancellationRequested &&
                State == ConnectionState.Connected)
            {
                SetState(ConnectionState.Disconnected);
            }
        }
        catch (OperationCanceledException)
        {
        }
        catch (ObjectDisposedException)
        {
        }
        catch (InvalidOperationException)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
            }
        }
        catch (IOException)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
            }
        }
        catch
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
                CleanupSerialPort();
            }
        }
    }

다음을 참조함 : _frameCodec, _protocolAdapter, _serialPort, CleanupSerialPort(), MessageReceived, SetState(), State.

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

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

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

◆ SendAsync()

async Task Dreamine.Communication.Serial.Ports.SerialPortTransport.SendAsync	(	MessageEnvelope	message,
		CancellationToken	cancellationToken = default )

inline

메시지를 외부 프로토콜과 프레임 형식으로 인코딩해 시리얼 포트로 전송합니다.

매개변수

message	전송할 메시지입니다.
cancellationToken	프레임 쓰기 취소 요청을 감시하는 토큰입니다.

반환값: 비동기 메시지 전송 작업입니다.

예외

InvalidOperationException 시리얼 포트가 열려 있지 않거나 전송 계층이 연결 상태가 아닌 경우 발생합니다.

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

    {
        ArgumentNullException.ThrowIfNull(message);
 
        if (_serialPort is null ||
            !_serialPort.IsOpen ||
            State != ConnectionState.Connected)
        {
            throw new InvalidOperationException("Serial port is not connected.");
        }
 
        try
        {
            var payload = _protocolAdapter.Encode(message);
 
            await _frameCodec.WriteFrameAsync(
                    _serialPort.BaseStream,
                    payload,
                    cancellationToken)
                .ConfigureAwait(false);
        }
        catch
        {
            SetState(ConnectionState.Faulted);
            CleanupSerialPort();
 
            throw;
        }
    }

다음을 참조함 : _frameCodec, _protocolAdapter, _serialPort, CleanupSerialPort(), SetState(), State.

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

◆ SetState()

void Dreamine.Communication.Serial.Ports.SerialPortTransport.SetState ( ConnectionState state )

inlineprivate

원자적 연산으로 현재 연결 상태를 설정합니다.

매개변수

state 저장할 새 연결 상태입니다.

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

    {
        Interlocked.Exchange(ref _state, (int)state);
    }

다음을 참조함 : _state.

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync(), ReceiveLoopAsync(), SendAsync().

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

◆ ValidateOptions()

void Dreamine.Communication.Serial.Ports.SerialPortTransport.ValidateOptions ( SerialPortTransportOptions options )

inlinestaticprivate

포트 이름, 회선 속성, 제한 시간 및 버퍼 크기의 유효성을 검사합니다.

매개변수

options 검증할 시리얼 포트 설정입니다.

예외

ArgumentException	포트 이름이 비어 있는 경우 발생합니다.
ArgumentOutOfRangeException	수치 설정이 허용 범위를 벗어난 경우 발생합니다.

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

    {
        ArgumentException.ThrowIfNullOrWhiteSpace(options.PortName);
 
        if (options.BaudRate <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.BaudRate));
        }
 
        if (options.DataBits is < 5 or > 8)
        {
            throw new ArgumentOutOfRangeException(nameof(options.DataBits));
        }
 
        if (options.ReadTimeoutMs < System.IO.Ports.SerialPort.InfiniteTimeout)
        {
            throw new ArgumentOutOfRangeException(nameof(options.ReadTimeoutMs));
        }
 
        if (options.WriteTimeoutMs < System.IO.Ports.SerialPort.InfiniteTimeout)
        {
            throw new ArgumentOutOfRangeException(nameof(options.WriteTimeoutMs));
        }
 
        if (options.ReadBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.ReadBufferSize));
        }
 
        if (options.WriteBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.WriteBufferSize));
        }
    }

다음을 참조함 : Dreamine.Communication.Serial.Options.SerialPortTransportOptions.BaudRate, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.DataBits, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.PortName, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.ReadBufferSize, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.ReadTimeoutMs, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.WriteBufferSize, Dreamine.Communication.Serial.Options.SerialPortTransportOptions.WriteTimeoutMs.

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

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

멤버 데이터 문서화

◆ _frameCodec

readonly IMessageFrameCodec Dreamine.Communication.Serial.Ports.SerialPortTransport._frameCodec

private

frame Codec 값을 보관합니다.

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

다음에 의해서 참조됨 : ReceiveLoopAsync(), SendAsync(), SerialPortTransport().

◆ _options

readonly SerialPortTransportOptions Dreamine.Communication.Serial.Ports.SerialPortTransport._options

private

options 값을 보관합니다.

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

다음에 의해서 참조됨 : ConnectAsync(), SerialPortTransport().

◆ _protocolAdapter

readonly IMessageProtocolAdapter Dreamine.Communication.Serial.Ports.SerialPortTransport._protocolAdapter

private

protocol Adapter 값을 보관합니다.

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

다음에 의해서 참조됨 : ReceiveLoopAsync(), SendAsync(), SerialPortTransport().

◆ _receiveLoopCts

CancellationTokenSource? Dreamine.Communication.Serial.Ports.SerialPortTransport._receiveLoopCts

private

receive Loop Cts 값을 보관합니다.

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

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync().

◆ _receiveLoopTask

Task? Dreamine.Communication.Serial.Ports.SerialPortTransport._receiveLoopTask

private

receive Loop Task 값을 보관합니다.

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

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync().

◆ _serialPort

SerialPort? Dreamine.Communication.Serial.Ports.SerialPortTransport._serialPort

private

serial Port 값을 보관합니다.

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

다음에 의해서 참조됨 : CleanupSerialPort(), ConnectAsync(), DisconnectAsync(), ReceiveLoopAsync(), SendAsync().

◆ _state

int Dreamine.Communication.Serial.Ports.SerialPortTransport._state = (int)ConnectionState.Disconnected

private

state 값을 보관합니다.

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

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

속성 문서화

◆ Kind

TransportKind Dreamine.Communication.Serial.Ports.SerialPortTransport.Kind

get

시리얼 전송 방식을 가져옵니다.

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

◆ State

ConnectionState Dreamine.Communication.Serial.Ports.SerialPortTransport.State

get

스레드 안전하게 현재 시리얼 연결 상태를 가져옵니다.

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

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync(), ReceiveLoopAsync(), SendAsync().

이벤트 문서화

◆ MessageReceived

EventHandler<MessageEnvelope>? Dreamine.Communication.Serial.Ports.SerialPortTransport.MessageReceived

완전한 프레임을 메시지로 디코딩했을 때 발생합니다.

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

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

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

SerialPortTransport.cs

Public 멤버 함수

속성

이벤트

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ SerialPortTransport() [1/2]

◆ SerialPortTransport() [2/2]

멤버 함수 문서화

◆ CleanupSerialPort()

◆ ConnectAsync()

◆ DisconnectAsync()

◆ DisposeAsync()

◆ ReceiveLoopAsync()

◆ SendAsync()

◆ SetState()

◆ ValidateOptions()

멤버 데이터 문서화

◆ _frameCodec

◆ _options

◆ _protocolAdapter

◆ _receiveLoopCts

◆ _receiveLoopTask

◆ _serialPort

◆ _state

속성 문서화

◆ Kind

◆ State

이벤트 문서화

◆ MessageReceived