Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer 클래스 참조

더 자세히 ...

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

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

Public 멤버 함수
	MitsubishiMcTcpSimulatorServer (MitsubishiMcSimulatorServerOptions options)
	MitsubishiMcTcpSimulatorServer (MitsubishiMcSimulatorServerOptions options, InMemoryPlcMemory memory)
Task	StartAsync (CancellationToken cancellationToken=default)
async Task	StopAsync ()
async ValueTask	DisposeAsync ()

속성
bool	IsRunning [get]

이벤트
EventHandler< string >?	StatusChanged

Private 멤버 함수
async Task	AcceptLoopAsync (CancellationToken cancellationToken)
async Task	HandleClientAsync (TcpClient client, CancellationToken cancellationToken)
void	OnProtocolStatusChanged (object? sender, string e)

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

Private 속성
readonly MitsubishiMcSimulatorServerOptions	_options
readonly MitsubishiMcBinary3ESimulatorProtocol	_protocol
readonly List< Task >	_clientTasks = []
readonly object	_syncRoot = new()
CancellationTokenSource?	_cts
TcpListener?	_listener
Task?	_acceptTask

상세한 설명

로컬 및 PC 간 테스트용 최소 Mitsubishi MC Binary 3E TCP 서버를 제공합니다.

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

생성자 & 소멸자 문서화

MitsubishiMcTcpSimulatorServer() [1/2]

Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.MitsubishiMcTcpSimulatorServer ( MitsubishiMcSimulatorServerOptions options )

inline

새 메모리와 지정한 옵션으로 TCP 서버를 초기화합니다.

매개변수

options

시뮬레이터 옵션입니다.

예외

ArgumentNullException

옵션이 null인 경우 발생합니다.

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

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

MitsubishiMcTcpSimulatorServer() [2/2]

Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.MitsubishiMcTcpSimulatorServer ( MitsubishiMcSimulatorServerOptions options, InMemoryPlcMemory memory )

inline

공유 메모리와 옵션으로 TCP 서버를 초기화합니다.

매개변수

options	옵션입니다.
memory	공유 메모리입니다.

예외

ArgumentNullException

옵션 또는 메모리가 null인 경우 발생합니다.

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

    {
        _options = options ?? throw new ArgumentNullException(nameof(options));
        _protocol = new MitsubishiMcBinary3ESimulatorProtocol(memory ?? throw new ArgumentNullException(nameof(memory)), options);
        _protocol.StatusChanged += OnProtocolStatusChanged;
    }

다음을 참조함 : _options, _protocol, OnProtocolStatusChanged().

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

멤버 함수 문서화

AcceptLoopAsync()

async Task Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.AcceptLoopAsync ( CancellationToken cancellationToken )

inlineprivate

TCP 클라이언트를 수락하고 처리 작업을 추적합니다.

매개변수

cancellationToken

취소 토큰입니다.

반환값

수락 루프입니다.

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

    {
        while (!cancellationToken.IsCancellationRequested && _listener is not null)
        {
            TcpClient client;
 
            try
            {
                client = await _listener.AcceptTcpClientAsync(cancellationToken).ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
                break;
            }
            catch (ObjectDisposedException)
            {
                break;
            }
 
            var task = Task.Run(() => HandleClientAsync(client, cancellationToken), CancellationToken.None);
            lock (_syncRoot)
            {
                _clientTasks.RemoveAll(static item => item.IsCompleted);
                _clientTasks.Add(task);
            }
        }
    }

다음을 참조함 : _clientTasks, _listener, _syncRoot, HandleClientAsync().

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

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

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

DisposeAsync()

async ValueTask Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.DisposeAsync ( )

inline

프로토콜 이벤트 구독을 해제하고 서버를 중지합니다.

반환값

비동기 해제 작업입니다.

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

    {
        _protocol.StatusChanged -= OnProtocolStatusChanged;
        await StopAsync().ConfigureAwait(false);
    }

다음을 참조함 : OnProtocolStatusChanged(), StopAsync().

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

HandleClientAsync()

async Task Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.HandleClientAsync ( TcpClient client, CancellationToken cancellationToken )

inlineprivate

한 클라이언트의 Binary 3E 프레임을 반복 처리합니다.

매개변수

client	클라이언트입니다.
cancellationToken	취소 토큰입니다.

반환값

처리 작업입니다.

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

    {
        using (client)
        using (var stream = client.GetStream())
        {
            StatusChanged?.Invoke(this, "MC TCP simulator client connected.");
 
            while (!cancellationToken.IsCancellationRequested)
            {
                byte[] request;
                try
                {
                    request = await ReceiveBinary3EFrameAsync(stream, cancellationToken).ConfigureAwait(false);
                }
                catch (OperationCanceledException)
                {
                    break;
                }
                catch (IOException)
                {
                    break;
                }
                catch (ObjectDisposedException)
                {
                    break;
                }
 
                var response = _protocol.Execute(request);
                await stream.WriteAsync(response, cancellationToken).ConfigureAwait(false);
                await stream.FlushAsync(cancellationToken).ConfigureAwait(false);
            }
        }
 
        StatusChanged?.Invoke(this, "MC TCP simulator client disconnected.");
    }

다음을 참조함 : _protocol, ReceiveBinary3EFrameAsync(), StatusChanged.

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

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

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

OnProtocolStatusChanged()

void Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.OnProtocolStatusChanged ( object? sender, string e )

inlineprivate

프로토콜 상태 메시지를 서버 이벤트로 전달합니다.

매개변수

sender	이벤트 원본입니다.
e	상태 메시지입니다.

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

    {
        StatusChanged?.Invoke(this, e);
    }

다음을 참조함 : StatusChanged.

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

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

ParseAddress()

IPAddress Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.ParseAddress ( string host )

inlinestaticprivate

바인딩 호스트를 IP 주소로 변환하며 잘못되면 Any를 사용합니다.

매개변수

host

호스트입니다.

반환값

IP 주소입니다.

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

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

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

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

ReadExactlyAsync()

async Task Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.ReadExactlyAsync ( NetworkStream stream, byte[] buffer, CancellationToken cancellationToken )

inlinestaticprivate

대상 버퍼가 찰 때까지 스트림을 읽습니다.

매개변수

stream	스트림입니다.
buffer	버퍼입니다.
cancellationToken	취소 토큰입니다.

반환값

읽기 작업입니다.

예외

IOException

버퍼가 차기 전에 연결이 닫힌 경우 발생합니다.

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

    {
        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 MC TCP simulator client closed the connection.");
            }
 
            offset += read;
        }
    }

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

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

ReceiveBinary3EFrameAsync()

async Task< byte[]> Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.ReceiveBinary3EFrameAsync ( NetworkStream stream, CancellationToken cancellationToken )

inlinestaticprivate

헤더의 데이터 길이에 맞춰 완전한 Binary 3E 요청을 읽습니다.

매개변수

stream	스트림입니다.
cancellationToken	취소 토큰입니다.

반환값

요청 프레임입니다.

예외

InvalidOperationException	데이터 길이가 잘못된 경우 발생합니다.
IOException	프레임 수신 중 연결이 닫힌 경우 발생합니다.

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

    {
        var header = new byte[9];
        await ReadExactlyAsync(stream, header, cancellationToken).ConfigureAwait(false);
 
        var requestDataLength = header[7] | (header[8] << 8);
        if (requestDataLength < 2)
        {
            throw new InvalidOperationException($"Invalid MC request data length: {requestDataLength}");
        }
 
        var body = new byte[requestDataLength];
        await ReadExactlyAsync(stream, body, cancellationToken).ConfigureAwait(false);
 
        var frame = new byte[header.Length + body.Length];
        Buffer.BlockCopy(header, 0, frame, 0, header.Length);
        Buffer.BlockCopy(body, 0, frame, header.Length, body.Length);
        return frame;
    }

다음을 참조함 : ReadExactlyAsync().

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

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

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

StartAsync()

Task Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.StartAsync ( CancellationToken cancellationToken = default )

inline

TCP 수신기와 수락 루프를 시작합니다.

매개변수

cancellationToken

서버 수명 토큰입니다.

반환값

시작 작업입니다.

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

    {
        if (_listener is not null)
        {
            return Task.CompletedTask;
        }
 
        var address = ParseAddress(_options.Host);
        _listener = new TcpListener(address, _options.Port);
        _listener.Start();
        _cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
        _acceptTask = Task.Run(() => AcceptLoopAsync(_cts.Token), CancellationToken.None);
        StatusChanged?.Invoke(this, $"MC TCP simulator server started. {_options.Host}:{_options.Port}");
        return Task.CompletedTask;
    }

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

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

StopAsync()

async Task Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.StopAsync ( )

inline

TCP 수신기를 중지하고 클라이언트 작업 종료를 기다립니다.

반환값

중지 작업입니다.

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

    {
        if (_listener is null)
        {
            return;
        }
 
        _cts?.Cancel();
        _listener.Stop();
        _listener = null;
 
        if (_acceptTask is not null)
        {
            try
            {
                await _acceptTask.ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
            }
            catch (ObjectDisposedException)
            {
            }
        }
 
        Task[] clientTasks;
        lock (_syncRoot)
        {
            clientTasks = _clientTasks.ToArray();
            _clientTasks.Clear();
        }
 
        try
        {
            await Task.WhenAll(clientTasks).ConfigureAwait(false);
        }
        catch
        {
        }
 
        _cts?.Dispose();
        _cts = null;
        StatusChanged?.Invoke(this, "MC TCP simulator server stopped.");
    }

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

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

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

멤버 데이터 문서화

_acceptTask

Task? Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._acceptTask

private

accept Task 값을 보관합니다.

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

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

_clientTasks

readonly List<Task> Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._clientTasks = []

private

client Tasks 값을 보관합니다.

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

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

_cts

CancellationTokenSource? Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._cts

private

cts 값을 보관합니다.

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

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

_listener

TcpListener? Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._listener

private

listener 값을 보관합니다.

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

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

_options

readonly MitsubishiMcSimulatorServerOptions Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._options

private

options 값을 보관합니다.

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

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

_protocol

readonly MitsubishiMcBinary3ESimulatorProtocol Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._protocol

private

protocol 값을 보관합니다.

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

다음에 의해서 참조됨 : HandleClientAsync(), MitsubishiMcTcpSimulatorServer().

_syncRoot

readonly object Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer._syncRoot = new()

private

sync Root 값을 보관합니다.

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

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

속성 문서화

IsRunning

bool Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.IsRunning

get

서버 실행 여부를 가져옵니다.

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

이벤트 문서화

StatusChanged

EventHandler<string>? Dreamine.PLC.Mitsubishi.MC.Simulation.MitsubishiMcTcpSimulatorServer.StatusChanged

서버 상태 메시지가 변경될 때 발생합니다.

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

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

---

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

• MitsubishiMcTcpSimulatorServer.cs