Dreamine.Communication.Sockets.Clients.TcpClientTransport에 대한 상속 다이어그램 :

Dreamine.Communication.Sockets.Clients.TcpClientTransport에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
	TcpClientTransport (TcpClientTransportOptions options)
	TcpClientTransport (TcpClientTransportOptions options, IMessageProtocolAdapter protocolAdapter, IMessageFrameCodec frameCodec)
async Task	ConnectAsync (CancellationToken cancellationToken=default)
async Task	DisconnectAsync (CancellationToken cancellationToken=default)
async Task	SendAsync (MessageEnvelope message, CancellationToken cancellationToken=default)
async ValueTask	DisposeAsync ()

속성
ConnectionState	State `[get]`
TransportKind	Kind `[get]`

이벤트
EventHandler< MessageEnvelope >?	MessageReceived

Private 멤버 함수
async Task	ReceiveLoopAsync (CancellationToken cancellationToken)
void	CleanupClient ()
void	SetState (ConnectionState state)

정적 Private 멤버 함수
static void	ValidateOptions (TcpClientTransportOptions options)

Private 속성
readonly TcpClientTransportOptions	_options
readonly IMessageProtocolAdapter	_protocolAdapter
readonly IMessageFrameCodec	_frameCodec
TcpClient?	_client
CancellationTokenSource?	_receiveLoopCts
Task?	_receiveLoopTask
int	_state = (int)ConnectionState.Disconnected

상세한 설명

TCP 클라이언트 연결에서 구성 가능한 프레임과 프로토콜로 메시지를 송수신합니다.

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

생성자 & 소멸자 문서화

◆ TcpClientTransport() [1/2]

Dreamine.Communication.Sockets.Clients.TcpClientTransport.TcpClientTransport ( TcpClientTransportOptions options )

inline

기본 Dreamine JSON 프로토콜과 길이 접두사 프레임으로 TCP 클라이언트를 초기화합니다.

매개변수

options 서버 주소, 버퍼 및 연결 제한 시간 설정입니다.

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

        : this(
            options,
            new DreamineEnvelopeProtocolAdapter(),
            new LengthPrefixedMessageFrameCodec())
    {
    }

◆ TcpClientTransport() [2/2]

Dreamine.Communication.Sockets.Clients.TcpClientTransport.TcpClientTransport	(	TcpClientTransportOptions	options,
		IMessageProtocolAdapter	protocolAdapter,
		IMessageFrameCodec	frameCodec )

inline

TCP 설정과 사용자 지정 프로토콜 및 프레임 코덱으로 클라이언트를 초기화합니다.

매개변수

options	서버 주소, 버퍼 및 연결 제한 시간 설정입니다.
protocolAdapter	메시지와 외부 페이로드를 변환할 어댑터입니다.
frameCodec	TCP 스트림의 메시지 경계를 처리할 코덱입니다.

예외

ArgumentNullException options , protocolAdapter 또는 frameCodec 이 null인 경우 발생합니다.

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

    {
        _options = options ?? throw new ArgumentNullException(nameof(options));
        _protocolAdapter = protocolAdapter ?? throw new ArgumentNullException(nameof(protocolAdapter));
        _frameCodec = frameCodec ?? throw new ArgumentNullException(nameof(frameCodec));
 
        ValidateOptions(_options);
    }

다음을 참조함 : _frameCodec, _options, _protocolAdapter, ValidateOptions().

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

멤버 함수 문서화

◆ CleanupClient()

void Dreamine.Communication.Sockets.Clients.TcpClientTransport.CleanupClient ( )

inlineprivate

정리 예외를 전파하지 않고 TCP 클라이언트를 닫고 해제합니다.

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

    {
        try
        {
            _client?.Close();
        }
        catch
        {
        }
 
        try
        {
            _client?.Dispose();
        }
        catch
        {
        }
 
        _client = null;
    }

다음을 참조함 : _client.

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

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

◆ ConnectAsync()

async Task Dreamine.Communication.Sockets.Clients.TcpClientTransport.ConnectAsync ( CancellationToken cancellationToken = default )

inline

제한 시간 내에 TCP 서버에 연결하고 백그라운드 수신 루프를 시작합니다.

매개변수

cancellationToken 연결 취소 요청을 감시하는 토큰입니다.

반환값: 비동기 TCP 연결 작업입니다.

예외

OperationCanceledException 사용자 취소 또는 연결 제한 시간 만료 시 발생할 수 있습니다.

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

    {
        if (State is ConnectionState.Connected or ConnectionState.Connecting)
        {
            return;
        }
 
        SetState(ConnectionState.Connecting);
 
        try
        {
            CleanupClient();
 
            _client = new TcpClient
            {
                ReceiveBufferSize = _options.ReceiveBufferSize,
                SendBufferSize = _options.SendBufferSize
            };
 
            using var timeoutCts = new CancellationTokenSource(_options.ConnectTimeoutMs);
            using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(
                cancellationToken,
                timeoutCts.Token);
 
            await _client.ConnectAsync(_options.Host, _options.Port, linkedCts.Token)
                .ConfigureAwait(false);
 
            SetState(ConnectionState.Connected);
 
            _receiveLoopCts = new CancellationTokenSource();
            _receiveLoopTask = Task.Run(
                () => ReceiveLoopAsync(_receiveLoopCts.Token),
                _receiveLoopCts.Token);
        }
        catch
        {
            SetState(ConnectionState.Faulted);
            CleanupClient();
 
            throw;
        }
    }

다음을 참조함 : _client, _options, _receiveLoopCts, _receiveLoopTask, CleanupClient(), ReceiveLoopAsync(), SetState(), State.

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

◆ DisconnectAsync()

async Task Dreamine.Communication.Sockets.Clients.TcpClientTransport.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

수신 루프를 중지하고 TCP 클라이언트 연결을 닫습니다.

매개변수

cancellationToken 정리 후 연결 해제 취소 여부를 확인하는 토큰입니다.

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

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

    {
        if (State == ConnectionState.Disconnected)
        {
            return;
        }
 
        SetState(ConnectionState.Disconnecting);
 
        _receiveLoopCts?.Cancel();
 
        CleanupClient();
 
        if (_receiveLoopTask is not null)
        {
            try
            {
                await _receiveLoopTask.ConfigureAwait(false);
            }
            catch (OperationCanceledException)
            {
            }
            catch (ObjectDisposedException)
            {
            }
            catch (SocketException)
            {
            }
            catch (IOException)
            {
            }
        }
 
        _receiveLoopCts?.Dispose();
        _receiveLoopCts = null;
        _receiveLoopTask = null;
 
        cancellationToken.ThrowIfCancellationRequested();
 
        SetState(ConnectionState.Disconnected);
    }

다음을 참조함 : _receiveLoopCts, _receiveLoopTask, CleanupClient(), SetState(), State.

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.Communication.Sockets.Clients.TcpClientTransport.DisposeAsync ( )

inline

TCP 연결과 수신 루프 리소스를 비동기적으로 해제합니다.

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

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

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

다음을 참조함 : DisconnectAsync().

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

◆ ReceiveLoopAsync()

async Task Dreamine.Communication.Sockets.Clients.TcpClientTransport.ReceiveLoopAsync ( CancellationToken cancellationToken )

inlineprivate

TCP 스트림에서 프레임을 계속 읽어 메시지로 디코딩하고 수신 이벤트를 발생시킵니다.

매개변수

cancellationToken 수신 루프 종료 토큰입니다.

반환값: 백그라운드 수신 루프 작업입니다.

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

    {
        if (_client is null)
        {
            return;
        }
 
        try
        {
            var stream = _client.GetStream();
 
            while (!cancellationToken.IsCancellationRequested &&
                   State == ConnectionState.Connected)
            {
                var payload = await _frameCodec.ReadFrameAsync(stream, cancellationToken)
                    .ConfigureAwait(false);
 
                if (payload is null)
                {
                    break;
                }
 
                var message = _protocolAdapter.Decode(payload);
                MessageReceived?.Invoke(this, message);
            }
 
            if (!cancellationToken.IsCancellationRequested &&
                State == ConnectionState.Connected)
            {
                SetState(ConnectionState.Disconnected);
                CleanupClient();
            }
        }
        catch (OperationCanceledException)
        {
        }
        catch (ObjectDisposedException)
        {
        }
        catch (SocketException)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
                CleanupClient();
            }
        }
        catch (IOException)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
                CleanupClient();
            }
        }
        catch
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
                CleanupClient();
            }
        }
    }

다음을 참조함 : _client, _frameCodec, _protocolAdapter, CleanupClient(), MessageReceived, SetState(), State.

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

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

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

◆ SendAsync()

async Task Dreamine.Communication.Sockets.Clients.TcpClientTransport.SendAsync	(	MessageEnvelope	message,
		CancellationToken	cancellationToken = default )

inline

메시지를 외부 프로토콜과 프레임 형식으로 인코딩해 TCP 서버로 전송합니다.

매개변수

message	전송할 메시지입니다.
cancellationToken	프레임 쓰기 취소 요청을 감시하는 토큰입니다.

반환값: 비동기 메시지 전송 작업입니다.

예외

ArgumentNullException	메시지가 `null`인 경우 발생합니다.
InvalidOperationException	TCP 클라이언트가 연결되지 않은 경우 발생합니다.

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

    {
        ArgumentNullException.ThrowIfNull(message);
 
        if (_client is null || State != ConnectionState.Connected)
        {
            throw new InvalidOperationException("TCP client is not connected.");
        }
 
        try
        {
            var stream = _client.GetStream();
            var payload = _protocolAdapter.Encode(message);
 
            await _frameCodec.WriteFrameAsync(stream, payload, cancellationToken)
                .ConfigureAwait(false);
        }
        catch
        {
            SetState(ConnectionState.Faulted);
            CleanupClient();
 
            throw;
        }
    }

다음을 참조함 : _client, _frameCodec, _protocolAdapter, CleanupClient(), SetState(), State.

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

◆ SetState()

void Dreamine.Communication.Sockets.Clients.TcpClientTransport.SetState ( ConnectionState state )

inlineprivate

원자적 연산으로 현재 연결 상태를 설정합니다.

매개변수

state 저장할 새 상태입니다.

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

    {
        Interlocked.Exchange(ref _state, (int)state);
    }

다음을 참조함 : _state.

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

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

◆ ValidateOptions()

void Dreamine.Communication.Sockets.Clients.TcpClientTransport.ValidateOptions ( TcpClientTransportOptions options )

inlinestaticprivate

TCP 호스트, 포트, 버퍼 및 연결 제한 시간 설정을 검증합니다.

매개변수

options 검증할 TCP 클라이언트 설정입니다.

예외

ArgumentException	호스트가 비어 있는 경우 발생합니다.
ArgumentOutOfRangeException	수치 설정이 허용 범위를 벗어난 경우 발생합니다.

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

    {
        ArgumentException.ThrowIfNullOrWhiteSpace(options.Host);
 
        if (options.Port <= 0 || options.Port > 65535)
        {
            throw new ArgumentOutOfRangeException(nameof(options.Port));
        }
 
        if (options.ReceiveBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.ReceiveBufferSize));
        }
 
        if (options.SendBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.SendBufferSize));
        }
 
        if (options.ConnectTimeoutMs <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.ConnectTimeoutMs));
        }
    }

다음을 참조함 : Dreamine.Communication.Sockets.Options.TcpClientTransportOptions.ConnectTimeoutMs, Dreamine.Communication.Sockets.Options.TcpClientTransportOptions.Host, Dreamine.Communication.Sockets.Options.TcpClientTransportOptions.Port, Dreamine.Communication.Sockets.Options.TcpClientTransportOptions.ReceiveBufferSize, Dreamine.Communication.Sockets.Options.TcpClientTransportOptions.SendBufferSize.

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

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

멤버 데이터 문서화

◆ _client

TcpClient? Dreamine.Communication.Sockets.Clients.TcpClientTransport._client

private

client 값을 보관합니다.

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

다음에 의해서 참조됨 : CleanupClient(), ConnectAsync(), ReceiveLoopAsync(), SendAsync().

◆ _frameCodec

readonly IMessageFrameCodec Dreamine.Communication.Sockets.Clients.TcpClientTransport._frameCodec

private

frame Codec 값을 보관합니다.

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

다음에 의해서 참조됨 : ReceiveLoopAsync(), SendAsync(), TcpClientTransport().

◆ _options

readonly TcpClientTransportOptions Dreamine.Communication.Sockets.Clients.TcpClientTransport._options

private

options 값을 보관합니다.

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

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

◆ _protocolAdapter

readonly IMessageProtocolAdapter Dreamine.Communication.Sockets.Clients.TcpClientTransport._protocolAdapter

private

protocol Adapter 값을 보관합니다.

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

다음에 의해서 참조됨 : ReceiveLoopAsync(), SendAsync(), TcpClientTransport().

◆ _receiveLoopCts

CancellationTokenSource? Dreamine.Communication.Sockets.Clients.TcpClientTransport._receiveLoopCts

private

receive Loop Cts 값을 보관합니다.

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

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

◆ _receiveLoopTask

Task? Dreamine.Communication.Sockets.Clients.TcpClientTransport._receiveLoopTask

private

receive Loop Task 값을 보관합니다.

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

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

◆ _state

int Dreamine.Communication.Sockets.Clients.TcpClientTransport._state = (int)ConnectionState.Disconnected

private

state 값을 보관합니다.

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

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

속성 문서화

◆ Kind

TransportKind Dreamine.Communication.Sockets.Clients.TcpClientTransport.Kind

get

TCP 전송 방식을 가져옵니다.

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

◆ State

ConnectionState Dreamine.Communication.Sockets.Clients.TcpClientTransport.State

get

스레드 안전하게 현재 TCP 연결 상태를 가져옵니다.

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

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

이벤트 문서화

◆ MessageReceived

EventHandler<MessageEnvelope>? Dreamine.Communication.Sockets.Clients.TcpClientTransport.MessageReceived

완전한 TCP 프레임을 메시지로 디코딩했을 때 발생합니다.

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

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

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

TcpClientTransport.cs

Public 멤버 함수

속성

이벤트

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ TcpClientTransport() [1/2]

◆ TcpClientTransport() [2/2]

멤버 함수 문서화

◆ CleanupClient()

◆ ConnectAsync()

◆ DisconnectAsync()

◆ DisposeAsync()

◆ ReceiveLoopAsync()

◆ SendAsync()

◆ SetState()

◆ ValidateOptions()

멤버 데이터 문서화

◆ _client

◆ _frameCodec

◆ _options

◆ _protocolAdapter

◆ _receiveLoopCts

◆ _receiveLoopTask

◆ _state

속성 문서화

◆ Kind

◆ State

이벤트 문서화

◆ MessageReceived