Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer에 대한 상속 다이어그램 :

Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
	OmronFinsTcpSimulatorServer (OmronFinsSimulatorServerOptions options)
	OmronFinsTcpSimulatorServer (OmronFinsSimulatorServerOptions options, InMemoryPlcMemory memory)
Task	StartAsync ()
async Task	StopAsync ()
async ValueTask	DisposeAsync ()

속성
bool	IsRunning `[get]`

이벤트
EventHandler< string >?	StatusChanged

Private 멤버 함수
async Task	AcceptLoopAsync (CancellationToken cancellationToken)
async Task	ClientLoopAsync (TcpClient client, CancellationToken cancellationToken)

정적 Private 멤버 함수
static IPAddress	ParseAddress (string host)
static async Task< byte[]>	ReceiveFinsTcpPacketAsync (NetworkStream stream, CancellationToken cancellationToken)
static async Task	ReadExactlyAsync (NetworkStream stream, byte[] buffer, CancellationToken cancellationToken)

Private 속성
readonly OmronFinsSimulatorServerOptions	_options
readonly InMemoryPlcMemory	_memory
readonly OmronFinsSimulatorProtocol	_protocol
readonly List< TcpClient >	_clients = []
readonly object	_syncRoot = new()
TcpListener?	_listener
CancellationTokenSource?	_cts
Task?	_acceptTask

상세한 설명

로컬 및 PC 간 테스트를 위한 최소 FINS/TCP 시뮬레이터 서버를 제공합니다.

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

생성자 & 소멸자 문서화

◆ OmronFinsTcpSimulatorServer() [1/2]

Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.OmronFinsTcpSimulatorServer ( OmronFinsSimulatorServerOptions options )

inline

새 메모리를 사용해 T:Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer 클래스의 새 인스턴스를 초기화합니다.

매개변수

options 바인딩 및 자동 응답 서버 옵션입니다.

예외

ArgumentNullException options 가 null일 때 발생합니다.

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

        : this(options, new InMemoryPlcMemory())
    {
    }

◆ OmronFinsTcpSimulatorServer() [2/2]

Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.OmronFinsTcpSimulatorServer	(	OmronFinsSimulatorServerOptions	options,
		InMemoryPlcMemory	memory )

inline

지정한 공유 메모리를 사용해 T:Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer 클래스의 새 인스턴스를 초기화합니다.

매개변수

options	바인딩 및 자동 응답 서버 옵션입니다.
memory	요청 간에 공유할 PLC 메모리입니다.

예외

ArgumentNullException options 또는 memory 가 null일 때 발생합니다.

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

    {
        _options = options ?? throw new ArgumentNullException(nameof(options));
        _memory = memory ?? throw new ArgumentNullException(nameof(memory));
        _protocol = new OmronFinsSimulatorProtocol(_memory, _options);
        _protocol.StatusChanged += (_, message) => StatusChanged?.Invoke(this, message);
    }

다음을 참조함 : _memory, _options, _protocol, StatusChanged.

멤버 함수 문서화

◆ AcceptLoopAsync()

async Task Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.AcceptLoopAsync ( CancellationToken cancellationToken )

inlineprivate

TCP 클라이언트 연결을 수락하고 각각의 처리 루프를 백그라운드에서 시작합니다.

매개변수

cancellationToken 연결 수락을 중지하는 토큰입니다.

반환값: 수락 루프 수명 동안 실행되는 작업입니다.

예외

SocketException 취소 이외의 이유로 클라이언트 수락이 실패할 때 발생할 수 있습니다.

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

    {
        while (!cancellationToken.IsCancellationRequested && _listener is not null)
        {
            TcpClient client;
 
            try
            {
                client = await _listener.AcceptTcpClientAsync(cancellationToken).ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
                break;
            }
            catch (ObjectDisposedException)
            {
                break;
            }
            catch (SocketException) when (cancellationToken.IsCancellationRequested)
            {
                break;
            }
 
            lock (_syncRoot)
            {
                _clients.Add(client);
            }
 
            _ = Task.Run(() => ClientLoopAsync(client, cancellationToken), cancellationToken);
        }
    }

다음을 참조함 : _clients, _listener, _syncRoot, ClientLoopAsync().

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

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

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

◆ ClientLoopAsync()

async Task Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.ClientLoopAsync	(	TcpClient	client,
		CancellationToken	cancellationToken )

inlineprivate

단일 TCP 클라이언트의 FINS/TCP 요청을 수신·처리·응답합니다.

매개변수

client	처리할 연결된 TCP 클라이언트입니다.
cancellationToken	클라이언트 루프를 중지하는 토큰입니다.

반환값: 클라이언트 연결 수명 동안 실행되는 작업입니다.

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

    {
        try
        {
            using (client)
            {
                var stream = client.GetStream();
                while (!cancellationToken.IsCancellationRequested && client.Connected)
                {
                    var packet = await ReceiveFinsTcpPacketAsync(stream, cancellationToken).ConfigureAwait(false);
                    var request = OmronFinsTcpPacket.Extract(packet);
                    var response = _protocol.HandleRequest(request);
                    var responsePacket = OmronFinsTcpPacket.Wrap(response);
                    await stream.WriteAsync(responsePacket, cancellationToken).ConfigureAwait(false);
                    await stream.FlushAsync(cancellationToken).ConfigureAwait(false);
                }
            }
        }
        catch (OperationCanceledException)
        {
        }
        catch (IOException)
        {
        }
        catch (SocketException)
        {
        }
        catch (ObjectDisposedException)
        {
        }
        catch (Exception ex)
        {
            StatusChanged?.Invoke(this, $"FINS TCP client error: {ex.Message}");
        }
        finally
        {
            lock (_syncRoot)
            {
                _clients.Remove(client);
            }
        }
    }

다음을 참조함 : _clients, _protocol, _syncRoot, Dreamine.PLC.Omron.Fins.Protocol.OmronFinsTcpPacket.Extract(), ReceiveFinsTcpPacketAsync(), StatusChanged, Dreamine.PLC.Omron.Fins.Protocol.OmronFinsTcpPacket.Wrap().

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.DisposeAsync ( )

inline

서버를 중지해 비동기로 정리합니다.

반환값: 비동기 정리 작업을 나타내는 값 작업입니다.

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

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

다음을 참조함 : StopAsync().

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

◆ ParseAddress()

IPAddress Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.ParseAddress ( string host )

inlinestaticprivate

구성된 바인딩 호스트를 IP 주소로 변환하며 와일드카드와 잘못된 값은 모든 인터페이스로 처리합니다.

매개변수

host	변환할 호스트 또는 와일드카드 문자열입니다.

반환값: 구문 분석된 주소 또는 IPAddress.Any입니다.

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

    {
        if (string.IsNullOrWhiteSpace(host) || host == "0.0.0.0" || host == "*" || host == "+")
        {
            return IPAddress.Any;
        }
 
        return IPAddress.TryParse(host, out var address) ? address : IPAddress.Any;
    }

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

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

◆ ReadExactlyAsync()

async Task Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.ReadExactlyAsync	(	NetworkStream	stream,
		byte[]	buffer,
		CancellationToken	cancellationToken )

inlinestaticprivate

네트워크 스트림에서 대상 버퍼를 끝까지 채웁니다.

매개변수

stream	읽을 네트워크 스트림입니다.
buffer	완전히 채울 대상 버퍼입니다.
cancellationToken	읽기를 취소하는 토큰입니다.

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

예외

IOException	버퍼를 채우기 전에 클라이언트가 연결을 닫으면 발생합니다.
OperationCanceledException	읽기가 취소되면 발생합니다.

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

    {
        var offset = 0;
        while (offset < buffer.Length)
        {
            var read = await stream.ReadAsync(buffer.AsMemory(offset, buffer.Length - offset), cancellationToken).ConfigureAwait(false);
            if (read == 0)
            {
                throw new IOException("The FINS TCP client closed the connection.");
            }
 
            offset += read;
        }
    }

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

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

◆ ReceiveFinsTcpPacketAsync()

async Task< byte[]> Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.ReceiveFinsTcpPacketAsync	(	NetworkStream	stream,
		CancellationToken	cancellationToken )

inlinestaticprivate

FINS/TCP 헤더와 선언된 본문 길이를 기준으로 패킷 하나를 정확히 수신합니다.

매개변수

stream	읽을 클라이언트 네트워크 스트림입니다.
cancellationToken	수신을 취소하는 토큰입니다.

반환값: 헤더와 본문을 포함한 완전한 FINS/TCP 패킷입니다.

예외

InvalidOperationException	헤더의 패킷 길이가 8보다 작을 때 발생합니다.
IOException	완전한 패킷을 받기 전에 클라이언트가 연결을 닫으면 발생합니다.
OperationCanceledException	수신이 취소되면 발생합니다.

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

    {
        var header = new byte[16];
        await ReadExactlyAsync(stream, header, cancellationToken).ConfigureAwait(false);
        var length = OmronFinsEndian.ReadInt32(header, 4);
        if (length < 8)
        {
            throw new InvalidOperationException($"Invalid FINS/TCP packet length: {length}.");
        }
 
        var body = new byte[length - 8];
        await ReadExactlyAsync(stream, body, cancellationToken).ConfigureAwait(false);
        var packet = new byte[header.Length + body.Length];
        Buffer.BlockCopy(header, 0, packet, 0, header.Length);
        Buffer.BlockCopy(body, 0, packet, header.Length, body.Length);
        return packet;
    }

다음을 참조함 : ReadExactlyAsync(), Dreamine.PLC.Omron.Fins.Protocol.OmronFinsEndian.ReadInt32().

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

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

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

◆ StartAsync()

Task Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.StartAsync ( )

inline

구성된 주소와 포트에서 TCP 수신을 시작하고 연결 수락 루프를 실행합니다.

반환값: 서버가 이미 실행 중이거나 시작이 완료되면 완료되는 작업입니다.

예외

SocketException	주소 또는 포트에서 수신을 시작할 수 없을 때 발생할 수 있습니다.
ArgumentOutOfRangeException	구성된 포트가 유효한 범위를 벗어날 때 발생할 수 있습니다.

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

    {
        if (IsRunning)
        {
            return Task.CompletedTask;
        }
 
        var address = ParseAddress(_options.Host);
 
        _cts = new CancellationTokenSource();
        _listener = new TcpListener(address, _options.Port);
        _listener.Start();
        _acceptTask = AcceptLoopAsync(_cts.Token);
        StatusChanged?.Invoke(this, $"FINS TCP simulator listening on {_options.Host}:{_options.Port}.");
        return Task.CompletedTask;
    }

다음을 참조함 : _acceptTask, _cts, _listener, _options, AcceptLoopAsync(), IsRunning, ParseAddress(), StatusChanged.

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

◆ StopAsync()

async Task Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.StopAsync ( )

inline

TCP 수신기와 모든 클라이언트를 닫고 수락 루프를 종료합니다.

반환값: 연결과 수락 루프의 종료 및 자원 정리를 나타내는 작업입니다.

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

    {
        if (!IsRunning)
        {
            return;
        }
 
        _cts?.Cancel();
        _listener?.Stop();
        _listener = null;
 
        TcpClient[] clients;
        lock (_syncRoot)
        {
            clients = _clients.ToArray();
            _clients.Clear();
        }
 
        foreach (var client in clients)
        {
            client.Dispose();
        }
 
        if (_acceptTask is not null)
        {
            try
            {
                await _acceptTask.ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
            }
            catch (ObjectDisposedException)
            {
            }
            catch (SocketException)
            {
            }
        }
 
        _cts?.Dispose();
        _cts = null;
        _acceptTask = null;
        StatusChanged?.Invoke(this, "FINS TCP simulator stopped.");
    }

다음을 참조함 : _acceptTask, _clients, _cts, _listener, _syncRoot, IsRunning, StatusChanged.

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

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

멤버 데이터 문서화

◆ _acceptTask

Task? Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._acceptTask

private

accept Task 값을 보관합니다.

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

다음에 의해서 참조됨 : StartAsync(), StopAsync().

◆ _clients

readonly List<TcpClient> Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._clients = []

private

clients 값을 보관합니다.

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

다음에 의해서 참조됨 : AcceptLoopAsync(), ClientLoopAsync(), StopAsync().

◆ _cts

CancellationTokenSource? Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._cts

private

cts 값을 보관합니다.

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

다음에 의해서 참조됨 : StartAsync(), StopAsync().

◆ _listener

TcpListener? Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._listener

private

listener 값을 보관합니다.

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

다음에 의해서 참조됨 : AcceptLoopAsync(), StartAsync(), StopAsync().

◆ _memory

readonly InMemoryPlcMemory Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._memory

private

memory 값을 보관합니다.

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

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

◆ _options

readonly OmronFinsSimulatorServerOptions Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._options

private

options 값을 보관합니다.

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

다음에 의해서 참조됨 : OmronFinsTcpSimulatorServer(), StartAsync().

◆ _protocol

readonly OmronFinsSimulatorProtocol Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._protocol

private

protocol 값을 보관합니다.

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

다음에 의해서 참조됨 : ClientLoopAsync(), OmronFinsTcpSimulatorServer().

◆ _syncRoot

readonly object Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer._syncRoot = new()

private

sync Root 값을 보관합니다.

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

다음에 의해서 참조됨 : AcceptLoopAsync(), ClientLoopAsync(), StopAsync().

속성 문서화

◆ IsRunning

bool Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.IsRunning

get

TCP 수신기가 생성되어 서버가 실행 중인지 여부를 가져옵니다.

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

다음에 의해서 참조됨 : StartAsync(), StopAsync().

이벤트 문서화

◆ StatusChanged

EventHandler<string>? Dreamine.PLC.Omron.Fins.Simulation.OmronFinsTcpSimulatorServer.StatusChanged

서버 상태 또는 프로토콜 상태가 변경될 때 발생합니다.

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

다음에 의해서 참조됨 : ClientLoopAsync(), OmronFinsTcpSimulatorServer(), StartAsync(), StopAsync().

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

OmronFinsTcpSimulatorServer.cs

Public 멤버 함수

속성

이벤트

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ OmronFinsTcpSimulatorServer() [1/2]

◆ OmronFinsTcpSimulatorServer() [2/2]

멤버 함수 문서화

◆ AcceptLoopAsync()

◆ ClientLoopAsync()

◆ DisposeAsync()

◆ ParseAddress()

◆ ReadExactlyAsync()

◆ ReceiveFinsTcpPacketAsync()

◆ StartAsync()

◆ StopAsync()

멤버 데이터 문서화

◆ _acceptTask

◆ _clients

◆ _cts

◆ _listener

◆ _memory

◆ _options

◆ _protocol

◆ _syncRoot

속성 문서화

◆ IsRunning

이벤트 문서화

◆ StatusChanged