Dreamine.Communication.Sockets.Udp.UdpTransport에 대한 상속 다이어그램 :

Dreamine.Communication.Sockets.Udp.UdpTransport에 대한 협력 다이어그램:

[범례]

Public 멤버 함수
	UdpTransport (UdpTransportOptions options)
	UdpTransport (UdpTransportOptions options, IMessageProtocolAdapter protocolAdapter)
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	SetState (ConnectionState state)

정적 Private 멤버 함수
static void	ValidateOptions (UdpTransportOptions options)
static void	ValidatePort (int port, string parameterName)

Private 속성
readonly UdpTransportOptions	_options
readonly IMessageProtocolAdapter	_protocolAdapter
UdpClient?	_client
IPEndPoint?	_remoteEndPoint
CancellationTokenSource?	_receiveLoopCts
Task?	_receiveLoopTask
int	_state = (int)ConnectionState.Disconnected

상세한 설명

UDP 데이터그램을 프로토콜 메시지로 변환해 송수신하는 전송 계층입니다.

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

생성자 & 소멸자 문서화

◆ UdpTransport() [1/2]

Dreamine.Communication.Sockets.Udp.UdpTransport.UdpTransport ( UdpTransportOptions options )

inline

기본 Dreamine JSON 프로토콜로 UDP 전송 계층을 초기화합니다.

매개변수

options 로컬·원격 엔드포인트와 소켓 설정입니다.

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

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

◆ UdpTransport() [2/2]

Dreamine.Communication.Sockets.Udp.UdpTransport.UdpTransport	(	UdpTransportOptions	options,
		IMessageProtocolAdapter	protocolAdapter )

inline

UDP 설정과 사용자 지정 프로토콜 어댑터로 전송 계층을 초기화합니다.

매개변수

options	로컬·원격 엔드포인트와 소켓 설정입니다.
protocolAdapter	메시지와 데이터그램 페이로드를 변환할 어댑터입니다.

예외

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

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

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

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

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

멤버 함수 문서화

◆ ConnectAsync()

Task Dreamine.Communication.Sockets.Udp.UdpTransport.ConnectAsync ( CancellationToken cancellationToken = default )

inline

로컬 엔드포인트에 UDP 소켓을 바인딩하고 백그라운드 수신 루프를 시작합니다.

매개변수

cancellationToken 연결 및 수신 루프 수명과 연결할 취소 토큰입니다.

반환값: UDP 소켓 시작 작업입니다.

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

    {
        if (State is ConnectionState.Connected or ConnectionState.Connecting)
        {
            return Task.CompletedTask;
        }
 
        cancellationToken.ThrowIfCancellationRequested();
 
        SetState(ConnectionState.Connecting);
 
        try
        {
            var localEndPoint = _options.CreateLocalEndPoint();
            _remoteEndPoint = _options.CreateRemoteEndPoint();
 
            _client = new UdpClient(AddressFamily.InterNetwork)
            {
                EnableBroadcast = _options.EnableBroadcast
            };
 
            _client.Client.ReceiveBufferSize = _options.ReceiveBufferSize;
            _client.Client.SendBufferSize = _options.SendBufferSize;
 
            if (_options.ReuseAddress)
            {
                _client.Client.SetSocketOption(
                    SocketOptionLevel.Socket,
                    SocketOptionName.ReuseAddress,
                    true);
            }
 
            _client.Client.Bind(localEndPoint);
 
            _receiveLoopCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
 
            SetState(ConnectionState.Connected);
 
            _receiveLoopTask = Task.Run(
                () => ReceiveLoopAsync(_receiveLoopCts.Token),
                _receiveLoopCts.Token);
 
            return Task.CompletedTask;
        }
        catch
        {
            SetState(ConnectionState.Faulted);
 
            _client?.Dispose();
            _client = null;
            _remoteEndPoint = null;
 
            _receiveLoopCts?.Dispose();
            _receiveLoopCts = null;
 
            throw;
        }
    }

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

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

◆ DisconnectAsync()

async Task Dreamine.Communication.Sockets.Udp.UdpTransport.DisconnectAsync ( CancellationToken cancellationToken = default )

inline

UDP 소켓을 닫고 백그라운드 수신 루프를 종료합니다.

매개변수

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

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

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

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

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

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

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

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

◆ DisposeAsync()

async ValueTask Dreamine.Communication.Sockets.Udp.UdpTransport.DisposeAsync ( )

inline

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

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

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

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

다음을 참조함 : DisconnectAsync().

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

◆ ReceiveLoopAsync()

async Task Dreamine.Communication.Sockets.Udp.UdpTransport.ReceiveLoopAsync ( CancellationToken cancellationToken )

inlineprivate

데이터그램을 계속 수신해 메시지로 디코딩하고 수신 이벤트를 발생시킵니다.

매개변수

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

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

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

    {
        if (_client is null)
        {
            return;
        }
 
        try
        {
            while (!cancellationToken.IsCancellationRequested &&
                   State == ConnectionState.Connected)
            {
                var result = await _client.ReceiveAsync(cancellationToken)
                    .ConfigureAwait(false);
 
                var message = _protocolAdapter.Decode(result.Buffer);
                MessageReceived?.Invoke(this, message);
            }
        }
        catch (OperationCanceledException)
        {
        }
        catch (ObjectDisposedException)
        {
        }
        catch (SocketException)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
            }
        }
        catch
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                SetState(ConnectionState.Faulted);
            }
        }
    }

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

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

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

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

◆ SendAsync()

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

inline

메시지를 프로토콜 페이로드로 인코딩해 구성된 원격 UDP 엔드포인트로 전송합니다.

매개변수

message	전송할 메시지입니다.
cancellationToken	데이터그램 송신 취소 요청을 감시하는 토큰입니다.

반환값: 비동기 데이터그램 송신 작업입니다.

예외

ArgumentNullException	메시지가 `null`인 경우 발생합니다.
InvalidOperationException	UDP 전송 계층이 연결되지 않은 경우 발생합니다.

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

    {
        ArgumentNullException.ThrowIfNull(message);
 
        if (_client is null ||
            _remoteEndPoint is null ||
            State != ConnectionState.Connected)
        {
            throw new InvalidOperationException("UDP transport is not connected.");
        }
 
        cancellationToken.ThrowIfCancellationRequested();
 
        var payload = _protocolAdapter.Encode(message);
 
        await _client.SendAsync(payload, _remoteEndPoint, cancellationToken)
            .ConfigureAwait(false);
    }

다음을 참조함 : _client, _protocolAdapter, _remoteEndPoint, State.

◆ SetState()

void Dreamine.Communication.Sockets.Udp.UdpTransport.SetState ( ConnectionState state )

inlineprivate

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

매개변수

state 저장할 새 상태입니다.

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

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

다음을 참조함 : _state.

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

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

◆ ValidateOptions()

void Dreamine.Communication.Sockets.Udp.UdpTransport.ValidateOptions ( UdpTransportOptions options )

inlinestaticprivate

UDP 호스트, 포트 및 버퍼 설정을 검증합니다.

매개변수

options 검증할 UDP 설정입니다.

예외

ArgumentOutOfRangeException 수신 또는 송신 버퍼 크기가 0 이하이거나 로컬·원격 포트가 허용 범위를 벗어난 경우 발생합니다.

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

    {
        ArgumentNullException.ThrowIfNull(options);
        ArgumentException.ThrowIfNullOrWhiteSpace(options.LocalHost);
        ArgumentException.ThrowIfNullOrWhiteSpace(options.RemoteHost);
 
        ValidatePort(options.LocalPort, nameof(options.LocalPort));
        ValidatePort(options.RemotePort, nameof(options.RemotePort));
 
        if (options.ReceiveBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.ReceiveBufferSize));
        }
 
        if (options.SendBufferSize <= 0)
        {
            throw new ArgumentOutOfRangeException(nameof(options.SendBufferSize));
        }
    }

다음을 참조함 : Dreamine.Communication.Sockets.Options.UdpTransportOptions.LocalHost, Dreamine.Communication.Sockets.Options.UdpTransportOptions.LocalPort, Dreamine.Communication.Sockets.Options.UdpTransportOptions.ReceiveBufferSize, Dreamine.Communication.Sockets.Options.UdpTransportOptions.RemoteHost, Dreamine.Communication.Sockets.Options.UdpTransportOptions.RemotePort, Dreamine.Communication.Sockets.Options.UdpTransportOptions.SendBufferSize, ValidatePort().

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

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

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

◆ ValidatePort()

void Dreamine.Communication.Sockets.Udp.UdpTransport.ValidatePort	(	int	port,
		string	parameterName )

inlinestaticprivate

UDP 포트가 유효한 사용자 포트 범위인지 검증합니다.

매개변수

port	검증할 포트 번호입니다.
parameterName	예외에 사용할 설정 이름입니다.

예외

ArgumentOutOfRangeException 포트가 1~65535 범위를 벗어난 경우 발생합니다.

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

    {
        if (port <= 0 || port > 65535)
        {
            throw new ArgumentOutOfRangeException(parameterName);
        }
    }

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

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

멤버 데이터 문서화

◆ _client

UdpClient? Dreamine.Communication.Sockets.Udp.UdpTransport._client

private

client 값을 보관합니다.

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

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

◆ _options

readonly UdpTransportOptions Dreamine.Communication.Sockets.Udp.UdpTransport._options

private

options 값을 보관합니다.

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

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

◆ _protocolAdapter

readonly IMessageProtocolAdapter Dreamine.Communication.Sockets.Udp.UdpTransport._protocolAdapter

private

protocol Adapter 값을 보관합니다.

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

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

◆ _receiveLoopCts

CancellationTokenSource? Dreamine.Communication.Sockets.Udp.UdpTransport._receiveLoopCts

private

receive Loop Cts 값을 보관합니다.

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

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

◆ _receiveLoopTask

Task? Dreamine.Communication.Sockets.Udp.UdpTransport._receiveLoopTask

private

receive Loop Task 값을 보관합니다.

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

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

◆ _remoteEndPoint

IPEndPoint? Dreamine.Communication.Sockets.Udp.UdpTransport._remoteEndPoint

private

remote End Point 값을 보관합니다.

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

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

◆ _state

int Dreamine.Communication.Sockets.Udp.UdpTransport._state = (int)ConnectionState.Disconnected

private

state 값을 보관합니다.

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

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

속성 문서화

◆ Kind

TransportKind Dreamine.Communication.Sockets.Udp.UdpTransport.Kind

get

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

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

◆ State

ConnectionState Dreamine.Communication.Sockets.Udp.UdpTransport.State

get

스레드 안전하게 현재 UDP 소켓 상태를 가져옵니다.

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

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

이벤트 문서화

◆ MessageReceived

EventHandler<MessageEnvelope>? Dreamine.Communication.Sockets.Udp.UdpTransport.MessageReceived

수신 데이터그램을 메시지로 디코딩했을 때 발생합니다.

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

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

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

UdpTransport.cs

Public 멤버 함수

속성

이벤트

Private 멤버 함수

정적 Private 멤버 함수

Private 속성

상세한 설명

생성자 & 소멸자 문서화

◆ UdpTransport() [1/2]

◆ UdpTransport() [2/2]

멤버 함수 문서화

◆ ConnectAsync()

◆ DisconnectAsync()

◆ DisposeAsync()

◆ ReceiveLoopAsync()

◆ SendAsync()

◆ SetState()

◆ ValidateOptions()

◆ ValidatePort()

멤버 데이터 문서화

◆ _client

◆ _options

◆ _protocolAdapter

◆ _receiveLoopCts

◆ _receiveLoopTask

◆ _remoteEndPoint

◆ _state

속성 문서화

◆ Kind

◆ State

이벤트 문서화

◆ MessageReceived