Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport에 대한 상속 다이어그램 :

[범례]

Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
async Task< PlcResult >	ConnectAsync (string host, int port, int timeoutMs, CancellationToken cancellationToken=default)
async Task< PlcResult >	DisconnectAsync (CancellationToken cancellationToken=default)
async Task< PlcResult< byte[]> >	SendAndReceiveAsync (IReadOnlyList< byte > requestFrame, int receiveTimeoutMs, int retryCount, CancellationToken cancellationToken=default)
async ValueTask	DisposeAsync ()

속성
bool	IsConnected `[get]`

Private 멤버 함수
Task	CloseCoreAsync ()
void	ThrowIfDisposed ()

Private 속성
readonly SemaphoreSlim	_syncLock = new(1, 1)
UdpClient?	_udpClient
IPEndPoint?	_remoteEndPoint
bool	_disposed

정적 Private 속성
const int	MaximumMcResponseFrameLength = 8192

상세한 설명

Mitsubishi MC 프로토콜용 UDP 전송을 제공합니다.

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

멤버 함수 문서화

◆ CloseCoreAsync()

Task Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.CloseCoreAsync ( )

inlineprivate

내부 UDP 클라이언트를 닫고 참조를 지웁니다.

반환값: 완료된 작업입니다.

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

    {
        try
        {
            _udpClient?.Close();
            _udpClient?.Dispose();
        }
        finally
        {
            _udpClient = null;
            _remoteEndPoint = null;
        }
 
        return Task.CompletedTask;
    }

다음을 참조함 : _remoteEndPoint, _udpClient.

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

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

◆ ConnectAsync()

async Task< PlcResult > Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.ConnectAsync	(	string	host,
		int	port,
		int	timeoutMs,
		CancellationToken	cancellationToken = default )

inline

호스트를 확인하고 연결된 UDP 클라이언트를 준비합니다.

매개변수

host	호스트입니다.
port	포트입니다.
timeoutMs	유효성 검사에 사용하는 연결 제한 시간입니다.
cancellationToken	취소 토큰입니다.

반환값: 준비 결과입니다.

예외

ArgumentException	호스트가 비어 있는 경우 발생합니다.
OperationCanceledException	잠금 대기 중 취소된 경우 발생합니다.

Dreamine.PLC.Mitsubishi.MC.Transport.IMitsubishiMcTransport를 구현.

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

    {
        ArgumentException.ThrowIfNullOrWhiteSpace(host);
 
        if (port is <= 0 or > 65535)
        {
            return PlcResult.Failure($"Invalid UDP port: {port}");
        }
 
        if (timeoutMs <= 0)
        {
            return PlcResult.Failure("The connection timeout must be greater than zero.");
        }
 
        await _syncLock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
        try
        {
            ThrowIfDisposed();
 
            await CloseCoreAsync().ConfigureAwait(false);
 
            var addresses = await Dns.GetHostAddressesAsync(host, cancellationToken).ConfigureAwait(false);
            var address = addresses.FirstOrDefault(a => a.AddressFamily == AddressFamily.InterNetwork)
                ?? addresses.FirstOrDefault();
 
            if (address is null)
            {
                return PlcResult.Failure($"Failed to resolve UDP host: {host}");
            }
 
            _remoteEndPoint = new IPEndPoint(address, port);
            _udpClient = new UdpClient(address.AddressFamily);
            _udpClient.Connect(_remoteEndPoint);
 
            return PlcResult.Success();
        }
        catch (OperationCanceledException ex)
        {
            await CloseCoreAsync().ConfigureAwait(false);
            return PlcResult.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            await CloseCoreAsync().ConfigureAwait(false);
            return PlcResult.Failure(ex.Message);
        }
        finally
        {
            _syncLock.Release();
        }
    }

다음을 참조함 : _remoteEndPoint, _syncLock, _udpClient, CloseCoreAsync(), ThrowIfDisposed().

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

◆ DisconnectAsync()

async Task< PlcResult > Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

UDP 클라이언트와 원격 끝점 정보를 해제합니다.

매개변수

cancellationToken 취소 토큰입니다.

반환값: 연결 해제 결과입니다.

예외

OperationCanceledException 잠금 대기 중 취소된 경우 발생합니다.

Dreamine.PLC.Mitsubishi.MC.Transport.IMitsubishiMcTransport를 구현.

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

    {
        await _syncLock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
        try
        {
            await CloseCoreAsync().ConfigureAwait(false);
            return PlcResult.Success();
        }
        catch (Exception ex)
        {
            return PlcResult.Failure(ex.Message);
        }
        finally
        {
            _syncLock.Release();
        }
    }

다음을 참조함 : _syncLock, CloseCoreAsync().

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.DisposeAsync ( )

inline

UDP 클라이언트와 동기화 리소스를 비동기 해제합니다.

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

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

    {
        if (_disposed)
        {
            return;
        }
 
        await DisconnectAsync().ConfigureAwait(false);
 
        _syncLock.Dispose();
        _disposed = true;
 
        GC.SuppressFinalize(this);
    }

다음을 참조함 : _disposed, _syncLock, DisconnectAsync().

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

◆ SendAndReceiveAsync()

async Task< PlcResult< byte[]> > Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.SendAndReceiveAsync	(	IReadOnlyList< byte >	requestFrame,
		int	receiveTimeoutMs,
		int	retryCount,
		CancellationToken	cancellationToken = default )

inline

UDP 요청을 보내고 제한 시간 실패 시 구성된 횟수만큼 재시도합니다.

매개변수

requestFrame	요청 프레임입니다.
receiveTimeoutMs	수신 제한 시간입니다.
retryCount	재시도 횟수입니다.
cancellationToken	취소 토큰입니다.

반환값: 응답 데이터그램 결과입니다.

예외

ArgumentNullException	요청이 `null`인 경우 발생합니다.
OperationCanceledException	잠금 대기 중 취소된 경우 발생합니다.

Dreamine.PLC.Mitsubishi.MC.Transport.IMitsubishiMcTransport를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(requestFrame);
 
        if (requestFrame.Count == 0)
        {
            return PlcResult<byte[]>.Failure("The request frame must not be empty.");
        }
 
        if (receiveTimeoutMs <= 0)
        {
            return PlcResult<byte[]>.Failure("The receive timeout must be greater than zero.");
        }
 
        await _syncLock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
        try
        {
            ThrowIfDisposed();
 
            if (_udpClient is null || _remoteEndPoint is null)
            {
                return PlcResult<byte[]>.Failure("The UDP transport is not ready.");
            }
 
            var attempts = Math.Max(1, retryCount);
            var requestBuffer = requestFrame as byte[] ?? requestFrame.ToArray();
            Exception? lastException = null;
 
            for (var attempt = 1; attempt <= attempts; attempt++)
            {
                cancellationToken.ThrowIfCancellationRequested();
 
                using var timeoutCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
                timeoutCts.CancelAfter(receiveTimeoutMs);
 
                try
                {
                    await _udpClient.SendAsync(requestBuffer, requestBuffer.Length).WaitAsync(timeoutCts.Token).ConfigureAwait(false);
                    var response = await _udpClient.ReceiveAsync().WaitAsync(timeoutCts.Token).ConfigureAwait(false);
 
                    if (response.Buffer.Length == 0)
                    {
                        lastException = new IOException("The UDP PLC response was empty.");
                        continue;
                    }
 
                    if (response.Buffer.Length > MaximumMcResponseFrameLength)
                    {
                        return PlcResult<byte[]>.Failure(
                            $"The UDP PLC response frame is too large. Length: {response.Buffer.Length}");
                    }
 
                    return PlcResult<byte[]>.Success(response.Buffer);
                }
                catch (OperationCanceledException ex) when (!cancellationToken.IsCancellationRequested)
                {
                    lastException = ex;
                }
                catch (SocketException ex)
                {
                    lastException = ex;
                }
                catch (IOException ex)
                {
                    lastException = ex;
                }
            }
 
            return PlcResult<byte[]>.Failure(
                lastException?.Message ?? "The UDP PLC request timed out.");
        }
        catch (OperationCanceledException ex)
        {
            return PlcResult<byte[]>.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            return PlcResult<byte[]>.Failure(ex.Message);
        }
        finally
        {
            _syncLock.Release();
        }
    }

다음을 참조함 : _remoteEndPoint, _syncLock, _udpClient, MaximumMcResponseFrameLength, ThrowIfDisposed().

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

◆ ThrowIfDisposed()

void Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.ThrowIfDisposed ( )

inlineprivate

전송이 이미 해제되었으면 예외를 발생시킵니다.

예외

ObjectDisposedException 해제된 경우 발생합니다.

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

    {
        ObjectDisposedException.ThrowIf(_disposed, GetType().Name);
    }

다음을 참조함 : _disposed.

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

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

멤버 데이터 문서화

◆ _disposed

bool Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport._disposed

private

disposed 값을 보관합니다.

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

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

◆ _remoteEndPoint

IPEndPoint? Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport._remoteEndPoint

private

remote End Point 값을 보관합니다.

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

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

◆ _syncLock

readonly SemaphoreSlim Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport._syncLock = new(1, 1)

private

sync Lock 값을 보관합니다.

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

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

◆ _udpClient

UdpClient? Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport._udpClient

private

udp Client 값을 보관합니다.

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

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

◆ MaximumMcResponseFrameLength

const int Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.MaximumMcResponseFrameLength = 8192

staticprivate

Maximum Mc Response Frame Length 값을 보관합니다.

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

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

속성 문서화

◆ IsConnected

bool Dreamine.PLC.Mitsubishi.MC.Transport.UdpMitsubishiMcTransport.IsConnected

get

UDP 클라이언트와 원격 끝점 준비 여부를 가져옵니다.

Dreamine.PLC.Mitsubishi.MC.Transport.IMitsubishiMcTransport를 구현.

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

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

UdpMitsubishiMcTransport.cs

Public 멤버 함수

속성

Private 멤버 함수

Private 속성

정적 Private 속성

상세한 설명

멤버 함수 문서화

◆ CloseCoreAsync()

◆ ConnectAsync()

◆ DisconnectAsync()

◆ DisposeAsync()

◆ SendAndReceiveAsync()

◆ ThrowIfDisposed()

멤버 데이터 문서화

◆ _disposed

◆ _remoteEndPoint

◆ _syncLock

◆ _udpClient

◆ MaximumMcResponseFrameLength

속성 문서화

◆ IsConnected