Dreamine.PLC.Core.Clients.PlcClientBase 클래스 참조

더 자세히 ...

Dreamine.PLC.Core.Clients.PlcClientBase에 대한 상속 다이어그램 :

Dreamine.PLC.Core.Clients.PlcClientBase에 대한 협력 다이어그램:

Public 멤버 함수
async Task< PlcResult >	ConnectAsync (CancellationToken cancellationToken=default)
async Task< PlcResult >	DisconnectAsync (CancellationToken cancellationToken=default)
async Task< PlcResult< bool[]> >	ReadBitsAsync (PlcAddress address, int count, CancellationToken cancellationToken=default)
async Task< PlcResult< short[]> >	ReadWordsAsync (PlcAddress address, int count, CancellationToken cancellationToken=default)
async Task< PlcResult >	WriteBitsAsync (PlcAddress address, IReadOnlyList< bool > values, CancellationToken cancellationToken=default)
async Task< PlcResult >	WriteWordsAsync (PlcAddress address, IReadOnlyList< short > values, CancellationToken cancellationToken=default)
virtual async ValueTask	DisposeAsync ()

Protected 멤버 함수
Task< PlcResult >	ConnectCoreAsync (CancellationToken cancellationToken)
Task< PlcResult >	DisconnectCoreAsync (CancellationToken cancellationToken)
Task< PlcResult< bool[]> >	ReadBitsCoreAsync (PlcAddress address, int count, CancellationToken cancellationToken)
Task< PlcResult< short[]> >	ReadWordsCoreAsync (PlcAddress address, int count, CancellationToken cancellationToken)
Task< PlcResult >	WriteBitsCoreAsync (PlcAddress address, IReadOnlyList< bool > values, CancellationToken cancellationToken)
Task< PlcResult >	WriteWordsCoreAsync (PlcAddress address, IReadOnlyList< short > values, CancellationToken cancellationToken)
void	SetState (PlcConnectionState state)

속성
PlcConnectionState	State = PlcConnectionState.Disconnected [get, private set]

이벤트
EventHandler< PlcConnectionState >?	StateChanged

Private 멤버 함수
void	ThrowIfDisposed ()

정적 Private 멤버 함수
static PlcResult	ValidateReadRequest (PlcAddress address, int count)
static PlcResult	ValidateWriteBitRequest (PlcAddress address, IReadOnlyList< bool > values)
static PlcResult	ValidateWriteWordRequest (PlcAddress address, IReadOnlyList< short > values)

Private 속성
readonly AsyncLock	_syncLock = new()
volatile bool	_disposed
int	_disposeGuard

상세한 설명

PLC 클라이언트의 공통 상태, 검증, 오류 처리 및 동기화를 구현합니다.

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

멤버 함수 문서화

ConnectAsync()

async Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.ConnectAsync ( CancellationToken cancellationToken = default )

inline

잠금을 획득하고 구체 전송에 연결하며 상태를 갱신합니다.

매개변수

cancellationToken

연결 및 잠금 대기 취소 토큰입니다.

반환값

연결 결과입니다.

예외

OperationCanceledException	잠금을 획득하기 전에 토큰이 취소된 경우 발생합니다.
ObjectDisposedException	클라이언트가 이미 해제된 경우 발생합니다.

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

    {
        using (await _syncLock.LockAsync(cancellationToken).ConfigureAwait(false))
        {
            ThrowIfDisposed();
 
            if (State == PlcConnectionState.Connected)
            {
                return PlcResult.Success();
            }
 
            SetState(PlcConnectionState.Connecting);
 
            try
            {
                var result = await ConnectCoreAsync(cancellationToken).ConfigureAwait(false);
 
                SetState(result.IsSuccess
                    ? PlcConnectionState.Connected
                    : PlcConnectionState.Faulted);
 
                return result;
            }
            catch (OperationCanceledException ex)
            {
                SetState(PlcConnectionState.Disconnected);
                return PlcResult.Failure(ex.Message);
            }
            catch (Exception ex)
            {
                SetState(PlcConnectionState.Faulted);
                return PlcResult.Failure(ex.Message);
            }
        }
    }

다음을 참조함 : _syncLock, ConnectCoreAsync(), SetState(), State, ThrowIfDisposed().

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

ConnectCoreAsync()

Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.ConnectCoreAsync ( CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송에 연결합니다.

매개변수

cancellationToken

취소 토큰입니다.

반환값

연결 결과입니다.

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

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

DisconnectAsync()

async Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

잠금을 획득하고 구체 전송 연결을 해제하며 상태를 갱신합니다.

매개변수

cancellationToken

연결 해제 및 잠금 대기 취소 토큰입니다.

반환값

연결 해제 결과입니다.

예외

OperationCanceledException

잠금을 획득하기 전에 토큰이 취소된 경우 발생합니다.

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

    {
        using (await _syncLock.LockAsync(cancellationToken).ConfigureAwait(false))
        {
            if (_disposed || State == PlcConnectionState.Disconnected)
            {
                return PlcResult.Success();
            }
 
            var previousState = State;
            SetState(PlcConnectionState.Disconnecting);
 
            try
            {
                var result = await DisconnectCoreAsync(cancellationToken).ConfigureAwait(false);
 
                SetState(PlcConnectionState.Disconnected);
                return result;
            }
            catch (OperationCanceledException ex)
            {
                SetState(previousState);
                return PlcResult.Failure(ex.Message);
            }
            catch (Exception ex)
            {
                SetState(PlcConnectionState.Faulted);
                return PlcResult.Failure(ex.Message);
            }
        }
    }

다음을 참조함 : _disposed, _syncLock, DisconnectCoreAsync(), SetState(), State.

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

DisconnectCoreAsync()

Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.DisconnectCoreAsync ( CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송 연결을 해제합니다.

매개변수

cancellationToken

취소 토큰입니다.

반환값

연결 해제 결과입니다.

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

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

DisposeAsync()

virtual async ValueTask Dreamine.PLC.Core.Clients.PlcClientBase.DisposeAsync ( )

inlinevirtual

동시 호출을 차단하고 구체 전송 연결을 최선 노력으로 해제합니다.

반환값

비동기 해제 작업입니다.

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

    {
        if (Interlocked.CompareExchange(ref _disposeGuard, 1, 0) != 0)
        {
            return;
        }
 
        // Set _disposed before disconnecting so ThrowIfDisposed blocks concurrent callers immediately.
        // DisconnectAsync checks _disposed and would short-circuit, so we disconnect directly here.
        _disposed = true;
 
        try
        {
            using (await _syncLock.LockAsync(CancellationToken.None).ConfigureAwait(false))
            {
                if (State is not (PlcConnectionState.Disconnected or PlcConnectionState.Disconnecting))
                {
                    SetState(PlcConnectionState.Disconnecting);
 
                    try
                    {
                        await DisconnectCoreAsync(CancellationToken.None).ConfigureAwait(false);
                    }
                    catch
                    {
                        // Ignore disconnect errors during disposal.
                    }
 
                    SetState(PlcConnectionState.Disconnected);
                }
            }
        }
        catch
        {
            // Ignore lock acquisition errors during disposal.
        }
 
        GC.SuppressFinalize(this);
    }

다음을 참조함 : _disposed, _disposeGuard, _syncLock, DisconnectCoreAsync(), SetState(), State.

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

ReadBitsAsync()

async Task< PlcResult< bool[]> > Dreamine.PLC.Core.Clients.PlcClientBase.ReadBitsAsync ( PlcAddress address, int count, CancellationToken cancellationToken = default )

inline

요청과 연결 상태를 검증한 뒤 구체 전송에서 비트를 읽습니다.

매개변수

address	시작 주소입니다.
count	읽을 비트 수입니다.
cancellationToken	읽기 취소 토큰입니다.

반환값

비트 읽기 결과입니다.

예외

ObjectDisposedException

클라이언트가 해제된 경우 발생합니다.

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

    {
        ThrowIfDisposed();
 
        var validationResult = ValidateReadRequest(address, count);
        if (!validationResult.IsSuccess)
        {
            return PlcResult<bool[]>.Failure(validationResult.Message ?? "Invalid PLC bit read request.", validationResult.ErrorCode);
        }
 
        if (State != PlcConnectionState.Connected)
        {
            return PlcResult<bool[]>.Failure("The PLC client is not connected.");
        }
 
        try
        {
            return await ReadBitsCoreAsync(address, count, cancellationToken).ConfigureAwait(false);
        }
        catch (OperationCanceledException ex)
        {
            return PlcResult<bool[]>.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            SetState(PlcConnectionState.Faulted);
            return PlcResult<bool[]>.Failure(ex.Message);
        }
    }

다음을 참조함 : ReadBitsCoreAsync(), SetState(), State, ThrowIfDisposed(), ValidateReadRequest().

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

ReadBitsCoreAsync()

Task< PlcResult< bool[]> > Dreamine.PLC.Core.Clients.PlcClientBase.ReadBitsCoreAsync ( PlcAddress address, int count, CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송에서 비트를 읽습니다.

매개변수

address	시작 주소입니다.
count	비트 수입니다.
cancellationToken	취소 토큰입니다.

반환값

비트 결과입니다.

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

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

ReadWordsAsync()

async Task< PlcResult< short[]> > Dreamine.PLC.Core.Clients.PlcClientBase.ReadWordsAsync ( PlcAddress address, int count, CancellationToken cancellationToken = default )

inline

요청과 연결 상태를 검증한 뒤 구체 전송에서 워드를 읽습니다.

매개변수

address	시작 주소입니다.
count	읽을 워드 수입니다.
cancellationToken	읽기 취소 토큰입니다.

반환값

워드 읽기 결과입니다.

예외

ObjectDisposedException

클라이언트가 해제된 경우 발생합니다.

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

    {
        ThrowIfDisposed();
 
        var validationResult = ValidateReadRequest(address, count);
        if (!validationResult.IsSuccess)
        {
            return PlcResult<short[]>.Failure(validationResult.Message ?? "Invalid PLC word read request.", validationResult.ErrorCode);
        }
 
        if (State != PlcConnectionState.Connected)
        {
            return PlcResult<short[]>.Failure("The PLC client is not connected.");
        }
 
        try
        {
            return await ReadWordsCoreAsync(address, count, cancellationToken).ConfigureAwait(false);
        }
        catch (OperationCanceledException ex)
        {
            return PlcResult<short[]>.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            SetState(PlcConnectionState.Faulted);
            return PlcResult<short[]>.Failure(ex.Message);
        }
    }

다음을 참조함 : ReadWordsCoreAsync(), SetState(), State, ThrowIfDisposed(), ValidateReadRequest().

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

ReadWordsCoreAsync()

Task< PlcResult< short[]> > Dreamine.PLC.Core.Clients.PlcClientBase.ReadWordsCoreAsync ( PlcAddress address, int count, CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송에서 워드를 읽습니다.

매개변수

address	시작 주소입니다.
count	워드 수입니다.
cancellationToken	취소 토큰입니다.

반환값

워드 결과입니다.

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

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

SetState()

void Dreamine.PLC.Core.Clients.PlcClientBase.SetState ( PlcConnectionState state )

inlineprotected

연결 상태를 변경하고 상태 변경 이벤트를 발생시킵니다.

매개변수

state

새 연결 상태입니다.

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

    {
        if (State == state)
        {
            return;
        }
 
        State = state;
        StateChanged?.Invoke(this, state);
    }

다음을 참조함 : State, StateChanged.

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync(), DisposeAsync(), ReadBitsAsync(), ReadWordsAsync(), WriteBitsAsync(), WriteWordsAsync().

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

ThrowIfDisposed()

void Dreamine.PLC.Core.Clients.PlcClientBase.ThrowIfDisposed ( )

inlineprivate

클라이언트가 이미 해제되었으면 예외를 발생시킵니다.

예외

ObjectDisposedException

이미 해제된 경우 발생합니다.

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

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

다음을 참조함 : _disposed.

다음에 의해서 참조됨 : ConnectAsync(), ReadBitsAsync(), ReadWordsAsync(), WriteBitsAsync(), WriteWordsAsync().

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

ValidateReadRequest()

PlcResult Dreamine.PLC.Core.Clients.PlcClientBase.ValidateReadRequest ( PlcAddress address, int count )

inlinestaticprivate

읽기 주소와 항목 수를 검증합니다.

매개변수

address	주소입니다.
count	항목 수입니다.

반환값

검증 결과입니다.

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

    {
        var addressResult = PlcValidation.ValidateAddress(address);
        if (!addressResult.IsSuccess)
        {
            return addressResult;
        }
 
        return PlcValidation.ValidateCount(count);
    }

다음을 참조함 : Dreamine.PLC.Core.Validation.PlcValidation.ValidateAddress(), Dreamine.PLC.Core.Validation.PlcValidation.ValidateCount().

다음에 의해서 참조됨 : ReadBitsAsync(), ReadWordsAsync().

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

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

ValidateWriteBitRequest()

PlcResult Dreamine.PLC.Core.Clients.PlcClientBase.ValidateWriteBitRequest ( PlcAddress address, IReadOnlyList< bool > values )

inlinestaticprivate

비트 쓰기 주소와 값 컬렉션을 검증합니다.

매개변수

address	주소입니다.
values	값입니다.

반환값

검증 결과입니다.

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

    {
        var addressResult = PlcValidation.ValidateAddress(address);
        if (!addressResult.IsSuccess)
        {
            return addressResult;
        }
 
        return PlcValidation.ValidateBitValues(values);
    }

다음을 참조함 : Dreamine.PLC.Core.Validation.PlcValidation.ValidateAddress(), Dreamine.PLC.Core.Validation.PlcValidation.ValidateBitValues().

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

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

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

ValidateWriteWordRequest()

PlcResult Dreamine.PLC.Core.Clients.PlcClientBase.ValidateWriteWordRequest ( PlcAddress address, IReadOnlyList< short > values )

inlinestaticprivate

워드 쓰기 주소와 값 컬렉션을 검증합니다.

매개변수

address	주소입니다.
values	값입니다.

반환값

검증 결과입니다.

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

    {
        var addressResult = PlcValidation.ValidateAddress(address);
        if (!addressResult.IsSuccess)
        {
            return addressResult;
        }
 
        return PlcValidation.ValidateWordValues(values);
    }

다음을 참조함 : Dreamine.PLC.Core.Validation.PlcValidation.ValidateAddress(), Dreamine.PLC.Core.Validation.PlcValidation.ValidateWordValues().

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

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

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

WriteBitsAsync()

async Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.WriteBitsAsync ( PlcAddress address, IReadOnlyList< bool > values, CancellationToken cancellationToken = default )

inline

요청과 연결 상태를 검증한 뒤 구체 전송에 비트를 씁니다.

매개변수

address	시작 주소입니다.
values	쓸 비트 값입니다.
cancellationToken	쓰기 취소 토큰입니다.

반환값

비트 쓰기 결과입니다.

예외

ObjectDisposedException

클라이언트가 해제된 경우 발생합니다.

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

    {
        ThrowIfDisposed();
 
        var validationResult = ValidateWriteBitRequest(address, values);
        if (!validationResult.IsSuccess)
        {
            return validationResult;
        }
 
        if (State != PlcConnectionState.Connected)
        {
            return PlcResult.Failure("The PLC client is not connected.");
        }
 
        try
        {
            return await WriteBitsCoreAsync(address, values, cancellationToken).ConfigureAwait(false);
        }
        catch (OperationCanceledException ex)
        {
            return PlcResult.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            SetState(PlcConnectionState.Faulted);
            return PlcResult.Failure(ex.Message);
        }
    }

다음을 참조함 : SetState(), State, ThrowIfDisposed(), ValidateWriteBitRequest(), WriteBitsCoreAsync().

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

WriteBitsCoreAsync()

Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.WriteBitsCoreAsync ( PlcAddress address, IReadOnlyList< bool > values, CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송에 비트를 씁니다.

매개변수

address	시작 주소입니다.
values	비트 값입니다.
cancellationToken	취소 토큰입니다.

반환값

쓰기 결과입니다.

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

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

WriteWordsAsync()

async Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.WriteWordsAsync ( PlcAddress address, IReadOnlyList< short > values, CancellationToken cancellationToken = default )

inline

요청과 연결 상태를 검증한 뒤 구체 전송에 워드를 씁니다.

매개변수

address	시작 주소입니다.
values	쓸 워드 값입니다.
cancellationToken	쓰기 취소 토큰입니다.

반환값

워드 쓰기 결과입니다.

예외

ObjectDisposedException

클라이언트가 해제된 경우 발생합니다.

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

    {
        ThrowIfDisposed();
 
        var validationResult = ValidateWriteWordRequest(address, values);
        if (!validationResult.IsSuccess)
        {
            return validationResult;
        }
 
        if (State != PlcConnectionState.Connected)
        {
            return PlcResult.Failure("The PLC client is not connected.");
        }
 
        try
        {
            return await WriteWordsCoreAsync(address, values, cancellationToken).ConfigureAwait(false);
        }
        catch (OperationCanceledException ex)
        {
            return PlcResult.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            SetState(PlcConnectionState.Faulted);
            return PlcResult.Failure(ex.Message);
        }
    }

다음을 참조함 : SetState(), State, ThrowIfDisposed(), ValidateWriteWordRequest(), WriteWordsCoreAsync().

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

WriteWordsCoreAsync()

Task< PlcResult > Dreamine.PLC.Core.Clients.PlcClientBase.WriteWordsCoreAsync ( PlcAddress address, IReadOnlyList< short > values, CancellationToken cancellationToken )

abstractprotected

구체 PLC 전송에 워드를 씁니다.

매개변수

address	시작 주소입니다.
values	워드 값입니다.
cancellationToken	취소 토큰입니다.

반환값

쓰기 결과입니다.

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

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

멤버 데이터 문서화

_disposed

volatile bool Dreamine.PLC.Core.Clients.PlcClientBase._disposed

private

disposed 값을 보관합니다.

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

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

_disposeGuard

int Dreamine.PLC.Core.Clients.PlcClientBase._disposeGuard

private

dispose Guard 값을 보관합니다.

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

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

_syncLock

readonly AsyncLock Dreamine.PLC.Core.Clients.PlcClientBase._syncLock = new()

private

sync Lock 값을 보관합니다.

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

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

속성 문서화

State

PlcConnectionState Dreamine.PLC.Core.Clients.PlcClientBase.State = PlcConnectionState.Disconnected

getprivate set

현재 PLC 연결 상태를 가져옵니다.

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

{ get; private set; } = PlcConnectionState.Disconnected;

다음에 의해서 참조됨 : ConnectAsync(), DisconnectAsync(), DisposeAsync(), ReadBitsAsync(), ReadWordsAsync(), SetState(), WriteBitsAsync(), WriteWordsAsync().

이벤트 문서화

StateChanged

EventHandler<PlcConnectionState>? Dreamine.PLC.Core.Clients.PlcClientBase.StateChanged

PLC 연결 상태가 변경될 때 발생합니다.

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

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

---

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

• PlcClientBase.cs