Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport에 대한 상속 다이어그램 :

[범례]

Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
	TcpFastechEthernetIoTransport (FastechEthernetIoOptions options)
async Task< IoResult >	ConnectAsync (CancellationToken cancellationToken=default)
async Task< IoResult >	DisconnectAsync (CancellationToken cancellationToken=default)
async Task< IoResult< byte[]> >	SendAndReceiveAsync (IReadOnlyList< byte > requestFrame, int receiveTimeoutMs, int expectedResponseLength, CancellationToken cancellationToken=default)
async ValueTask	DisposeAsync ()

속성
bool	IsConnected `[get]`

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

정적 Private 멤버 함수
static async Task< byte[]>	ReadExactlyAsync (NetworkStream stream, int length, CancellationToken cancellationToken)
static async Task< byte[]>	ReadAvailableAsync (NetworkStream stream, CancellationToken cancellationToken)

Private 속성
readonly SemaphoreSlim	_syncLock = new(1, 1)
readonly FastechEthernetIoOptions	_options
TcpClient?	_tcpClient
NetworkStream?	_stream
bool	_disposed

정적 Private 속성
const int	DefaultReceiveBufferSize = 4096

상세한 설명

Fastech Ethernet I/O 통신을 위한 TCP 전송을 제공합니다.

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

생성자 & 소멸자 문서화

◆ TcpFastechEthernetIoTransport()

Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.TcpFastechEthernetIoTransport ( FastechEthernetIoOptions options )

inline

TcpFastechEthernetIoTransport 클래스의 새 인스턴스를 초기화합니다.

매개변수

options Fastech Ethernet I/O 연결 옵션입니다.

예외

ArgumentNullException options 가 null인 경우 발생합니다.

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

    {
        _options = options ?? throw new ArgumentNullException(nameof(options));
    }

다음을 참조함 : _options.

멤버 함수 문서화

◆ CloseCoreAsync()

Task Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.CloseCoreAsync ( )

inlineprivate

내부 TCP 스트림과 클라이언트를 닫고 참조를 초기화합니다.

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

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

    {
        try
        {
            _stream?.Dispose();
            _tcpClient?.Dispose();
        }
        finally
        {
            _stream = null;
            _tcpClient = null;
        }
 
        return Task.CompletedTask;
    }

다음을 참조함 : _stream, _tcpClient.

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

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

◆ ConnectAsync()

async Task< IoResult > Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.ConnectAsync ( CancellationToken cancellationToken = default )

inline

구성된 호스트와 포트에 TCP 연결을 설정합니다.

매개변수

cancellationToken 연결 작업 취소를 관찰하는 토큰입니다.

반환값: 연결 성공 여부와 실패 메시지를 포함한 결과입니다.

예외

OperationCanceledException 동기화 잠금을 기다리는 동안 cancellationToken 이 취소된 경우 발생합니다.

Dreamine.IO.Fastech.Ethernet.Transport.IFastechEthernetIoTransport를 구현.

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

    {
        if (string.IsNullOrWhiteSpace(_options.Host))
        {
            return IoResult.Failure("The Fastech host must not be empty.");
        }
 
        if (_options.Port is <= 0 or > 65535)
        {
            return IoResult.Failure($"Invalid TCP port: {_options.Port}.");
        }
 
        if (_options.ConnectTimeoutMs <= 0)
        {
            return IoResult.Failure("The connection timeout must be greater than zero.");
        }
 
        await _syncLock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
        try
        {
            ThrowIfDisposed();
 
            if (IsConnected)
            {
                return IoResult.Success();
            }
 
            await CloseCoreAsync().ConfigureAwait(false);
 
            _tcpClient = new TcpClient
            {
                NoDelay = true
            };
 
            using var timeoutCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
            timeoutCts.CancelAfter(_options.ConnectTimeoutMs);
 
            await _tcpClient.ConnectAsync(_options.Host, _options.Port, timeoutCts.Token).ConfigureAwait(false);
            _stream = _tcpClient.GetStream();
 
            return IoResult.Success();
        }
        catch (OperationCanceledException ex)
        {
            await CloseCoreAsync().ConfigureAwait(false);
            return IoResult.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            await CloseCoreAsync().ConfigureAwait(false);
            return IoResult.Failure(ex.Message);
        }
        finally
        {
            _syncLock.Release();
        }
    }

다음을 참조함 : _options, _stream, _syncLock, _tcpClient, CloseCoreAsync(), IsConnected, ThrowIfDisposed().

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

◆ DisconnectAsync()

async Task< IoResult > Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

현재 TCP 연결과 스트림을 닫습니다.

매개변수

cancellationToken 연결 해제 작업 취소를 관찰하는 토큰입니다.

반환값: 연결 해제 성공 여부와 실패 메시지를 포함한 결과입니다.

예외

OperationCanceledException 동기화 잠금을 기다리는 동안 cancellationToken 이 취소된 경우 발생합니다.

Dreamine.IO.Fastech.Ethernet.Transport.IFastechEthernetIoTransport를 구현.

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

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

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

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.DisposeAsync ( )

inline

연결과 동기화 리소스를 비동기적으로 해제합니다.

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

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

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

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

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

◆ ReadAvailableAsync()

async Task< byte[]> Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.ReadAvailableAsync	(	NetworkStream	stream,
		CancellationToken	cancellationToken )

inlinestaticprivate

스트림에서 현재 수신 가능한 데이터를 한 번 읽습니다.

매개변수

stream	읽을 네트워크 스트림입니다.
cancellationToken	읽기 취소를 관찰하는 토큰입니다.

반환값: 수신한 바이트 배열입니다.

예외

IOException 데이터를 읽기 전에 원격 끝점이 연결을 닫은 경우 발생합니다.

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

    {
        var buffer = new byte[DefaultReceiveBufferSize];
        var read = await stream.ReadAsync(buffer, cancellationToken).ConfigureAwait(false);
 
        if (read == 0)
        {
            throw new IOException("The remote Fastech endpoint closed the TCP connection.");
        }
 
        return buffer[..read];
    }

다음을 참조함 : DefaultReceiveBufferSize.

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

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

◆ ReadExactlyAsync()

async Task< byte[]> Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.ReadExactlyAsync	(	NetworkStream	stream,
		int	length,
		CancellationToken	cancellationToken )

inlinestaticprivate

스트림에서 지정된 바이트 수를 모두 읽습니다.

매개변수

stream	읽을 네트워크 스트림입니다.
length	읽어야 할 바이트 수입니다.
cancellationToken	읽기 취소를 관찰하는 토큰입니다.

반환값: 정확히 요청된 길이의 바이트 배열입니다.

예외

IOException 요청된 길이를 읽기 전에 원격 끝점이 연결을 닫은 경우 발생합니다.

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

    {
        var buffer = new byte[length];
        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 remote Fastech endpoint closed the TCP connection.");
            }
 
            offset += read;
        }
 
        return buffer;
    }

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

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

◆ SendAndReceiveAsync()

async Task< IoResult< byte[]> > Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.SendAndReceiveAsync	(	IReadOnlyList< byte >	requestFrame,
		int	receiveTimeoutMs,
		int	expectedResponseLength,
		CancellationToken	cancellationToken = default )

inline

요청 프레임을 전송하고 TCP 응답 프레임을 수신합니다.

매개변수

requestFrame	전송할 요청 바이트입니다.
receiveTimeoutMs	밀리초 단위의 수신 제한 시간입니다.
expectedResponseLength	기대하는 응답 길이이며, 0이면 한 번에 사용 가능한 데이터를 읽습니다.
cancellationToken	송수신 작업 취소를 관찰하는 토큰입니다.

반환값: 수신한 바이트 또는 실패 메시지를 포함한 결과입니다.

예외

ArgumentNullException	requestFrame 이 `null`인 경우 발생합니다.
OperationCanceledException	동기화 잠금을 기다리는 동안 cancellationToken 이 취소된 경우 발생합니다.

Dreamine.IO.Fastech.Ethernet.Transport.IFastechEthernetIoTransport를 구현.

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

    {
        ArgumentNullException.ThrowIfNull(requestFrame);
 
        if (requestFrame.Count == 0)
        {
            return IoResult<byte[]>.Failure("The request frame must not be empty.");
        }
 
        if (receiveTimeoutMs <= 0)
        {
            return IoResult<byte[]>.Failure("The receive timeout must be greater than zero.");
        }
 
        if (expectedResponseLength < 0)
        {
            return IoResult<byte[]>.Failure("The expected response length must not be negative.");
        }
 
        await _syncLock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
        try
        {
            ThrowIfDisposed();
 
            if (_stream is null || _tcpClient is null || !_tcpClient.Connected)
            {
                return IoResult<byte[]>.Failure("The Fastech TCP transport is not connected.");
            }
 
            var requestBuffer = requestFrame as byte[] ?? requestFrame.ToArray();
 
            using var timeoutCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
            timeoutCts.CancelAfter(receiveTimeoutMs);
 
            await _stream.WriteAsync(requestBuffer, timeoutCts.Token).ConfigureAwait(false);
            await _stream.FlushAsync(timeoutCts.Token).ConfigureAwait(false);
 
            var response = expectedResponseLength > 0
                ? await ReadExactlyAsync(_stream, expectedResponseLength, timeoutCts.Token).ConfigureAwait(false)
                : await ReadAvailableAsync(_stream, timeoutCts.Token).ConfigureAwait(false);
 
            return IoResult<byte[]>.Success(response);
        }
        catch (OperationCanceledException ex)
        {
            return IoResult<byte[]>.Failure(ex.Message);
        }
        catch (Exception ex)
        {
            return IoResult<byte[]>.Failure(ex.Message);
        }
        finally
        {
            _syncLock.Release();
        }
    }

다음을 참조함 : _stream, _syncLock, _tcpClient, ReadAvailableAsync(), ReadExactlyAsync(), ThrowIfDisposed().

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

◆ ThrowIfDisposed()

void Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.ThrowIfDisposed ( )

inlineprivate

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

예외

ObjectDisposedException 객체가 이미 해제된 경우 발생합니다.

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

    {
        ObjectDisposedException.ThrowIf(_disposed, this);
    }

다음을 참조함 : _disposed.

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

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

멤버 데이터 문서화

◆ _disposed

bool Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport._disposed

private

disposed 값을 보관합니다.

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

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

◆ _options

readonly FastechEthernetIoOptions Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport._options

private

options 값을 보관합니다.

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

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

◆ _stream

NetworkStream? Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport._stream

private

stream 값을 보관합니다.

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

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

◆ _syncLock

readonly SemaphoreSlim Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport._syncLock = new(1, 1)

private

sync Lock 값을 보관합니다.

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

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

◆ _tcpClient

TcpClient? Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport._tcpClient

private

tcp Client 값을 보관합니다.

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

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

◆ DefaultReceiveBufferSize

const int Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.DefaultReceiveBufferSize = 4096

staticprivate

Default Receive Buffer Size 값을 보관합니다.

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

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

속성 문서화

◆ IsConnected

bool Dreamine.IO.Fastech.Ethernet.Transport.TcpFastechEthernetIoTransport.IsConnected

get

TCP 클라이언트와 네트워크 스트림이 연결되어 있는지 여부를 가져옵니다.

Dreamine.IO.Fastech.Ethernet.Transport.IFastechEthernetIoTransport를 구현.

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

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

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

TcpFastechEthernetIoTransport.cs

Public 멤버 함수

속성

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

정적 Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ TcpFastechEthernetIoTransport()

멤버 함수 문서화

◆ CloseCoreAsync()

◆ ConnectAsync()

◆ DisconnectAsync()

◆ DisposeAsync()

◆ ReadAvailableAsync()

◆ ReadExactlyAsync()

◆ SendAndReceiveAsync()

◆ ThrowIfDisposed()

멤버 데이터 문서화

◆ _disposed

◆ _options

◆ _stream

◆ _syncLock

◆ _tcpClient

◆ DefaultReceiveBufferSize

속성 문서화

◆ IsConnected