Microsoft MVP성태의 닷넷 이야기
닷넷: 2198. C# - Reflection을 이용한 ClientWebSocket의 Ping 호출 [링크 복사], [링크+제목 복사],
조회: 3351
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 1개 있습니다.)
(시리즈 글이 4개 있습니다.)
닷넷: 2188. C# - ASP.NET Core SignalR로 구현하는 채팅 서비스 예제
; https://www.sysnet.pe.kr/2/0/13504

닷넷: 2189. C# - WebSocket 클라이언트를 닷넷으로 구현하는 예제 (System.Net.WebSockets)
; https://www.sysnet.pe.kr/2/0/13505

닷넷: 2197. C# - ClientWebSocket의 Ping, Pong 처리
; https://www.sysnet.pe.kr/2/0/13518

닷넷: 2198. C# - Reflection을 이용한 ClientWebSocket의 Ping 호출
; https://www.sysnet.pe.kr/2/0/13519




C# - Reflection을 이용한 ClientWebSocket의 Ping 호출

지난 글에 Ping/Pong이 ClientWebSocket에 의해 어떻게 처리되는지 살펴봤습니다.

C# - ClientWebSocket의 Ping, Pong 처리
; https://www.sysnet.pe.kr/2/0/13518

언급했듯이, (서버 측 nodejs는 Ping을 전송하고 Pong을 받는데) C#의 ClientWebSocket은 무조건 Pong을 전송하는 식입니다. 그렇다면 혹시 Ping을 전송하는 방법은 없을까요?

이미 설명한 것처럼, 모든 처리는 ManagedWebSocket 내부에서 자동으로 수행되는데다 ClientWebSocket이 호출하는 Send 메서드는 내부적으로 Binary와 Text 유형만 보낼 수 있도록 고정했기 때문에,

public override ValueTask SendAsync(ReadOnlyMemory<byte> buffer, WebSocketMessageType messageType, WebSocketMessageFlags messageFlags, CancellationToken cancellationToken)
{
    // ...[생략]...
    MessageOpcode opcode;

    if (_lastSendWasFragment)
    {
        if (_lastSendHadDisableCompression != disableCompression)
        {
            throw new ArgumentException(SR.net_WebSockets_Argument_MessageFlagsHasDifferentCompressionOptions, nameof(messageFlags));
        }
        opcode = MessageOpcode.Continuation;
    }
    else
    {
        opcode = messageType == WebSocketMessageType.Binary ? MessageOpcode.Binary : MessageOpcode.Text;
    }

    ValueTask t = SendFrameAsync(opcode, endOfMessage, disableCompression, buffer, cancellationToken);
    // ...[생략]...

    return t;
}

딱히 제어를 할 수 있는 여지가 없습니다. 정 원한다면, 가령 테스트를 위해서 필요하다면 Reflection을 이용해 처리하는 수밖에 없습니다.

그다지 어렵지 않으니 간단하게 코드로 만들어 볼까요? ^^ 우선 SocketHandle과 ManagedWebSocket을 차례로 구하는 것부터 시작해야 합니다.

private static object? GetSocketHandle(ClientWebSocket ws)
{
    Type type = ws.GetType();
    FieldInfo? fi = type.GetField("_innerWebSocket", BindingFlags.NonPublic | BindingFlags.Instance);
    if (fi == null)
    {
        return null;
    }

    return fi.GetValue(ws);
}

private static WebSocket? GetManagedSocket(ClientWebSocket ws)
{
    var webSocketHandle = GetSocketHandle(ws);
    if (webSocketHandle == null)
    {
        return null;
    }

    Type type = webSocketHandle.GetType();
    return type.GetProperty("WebSocket", BindingFlags.Public | BindingFlags.Instance)?.GetValue(webSocketHandle)
        as WebSocket;
}

이후 남은 작업은, ManagedWebSocket이 구현한 Pong 코드를 참조해,

private async ValueTask HandleReceivedPingPongAsync(MessageHeader header, CancellationToken cancellationToken)
{
    // ...[생략]...

    // If this was a ping, send back a pong response.
    if (header.Opcode == MessageOpcode.Ping)
    {
        // ...[생략]...
        await SendFrameAsync(
            MessageOpcode.Pong,)
            endOfMessage: true,
            disableCompression: true,
            _receiveBuffer.Slice(_receiveBufferOffset, (int)header.PayloadLength),
            cancellationToken).ConfigureAwait(false);
    }

    // ...[생략]...
}

우리도 저 SendFrameAsync 메서드를 이용해 MessageOpcode.Ping (0x9)에 해당하는 값을 전송하도록 맞춰주기만 하면 됩니다.

private static ValueTask SendPingFrameAsync(WebSocket managedSocket)
{
    Type type = managedSocket.GetType();
    MethodInfo? targetMi = null;

    foreach (MethodInfo mi in type.GetMethods(BindingFlags.NonPublic | BindingFlags.Instance))
    {
        if (mi.Name == "SendFrameAsync" && mi.GetParameters().Length == 5)
        {
            targetMi = mi;
            break;
        }
    }

    if (targetMi == null)
    {
        throw new NullReferenceException("SendFrameAsync not found");
    }

    /*
    private enum MessageOpcode : byte
    {
        Continuation = 0x0,
        Text = 0x1,
        Binary = 0x2,
        Close = 0x8,
        Ping = 0x9,
        Pong = 0xA
    }
    */

    object? objValue = targetMi.Invoke(managedSocket, new object?[] { (byte)0x9, true, true, ReadOnlyMemory<byte>.Empty, CancellationToken.None });
    if (objValue == null)
    {
        throw new NullReferenceException("SendFrameAsync returned null");
    }

    return (ValueTask)objValue;
}

private static void SendKeepAliveFrame(WebSocket managedSocket)
{
    ValueTask t = SendPingFrameAsync(managedSocket);
    if (t.IsCompletedSuccessfully)
    {
        t.GetAwaiter().GetResult();
    }
    else
    {
        // "Observe" any exception, ignoring it to prevent the unobserved exception event from being raised.
        t.AsTask().ContinueWith(static p => { _ = p.Exception; },
            CancellationToken.None,
            TaskContinuationOptions.OnlyOnFaulted | TaskContinuationOptions.ExecuteSynchronously,
            TaskScheduler.Default);
    }
}

끝이군요. ^^ 이제 위에서 구현한 SendKeepAliveFrame 메서드를 ClientWebSocket에 적용해 다음과 같이 일부러 Ping을 전송하는 코드를 만들 수 있습니다.

string url = "ws://localhost:18000/";

var connectTimeout = new CancellationTokenSource();
connectTimeout.CancelAfter(2000);

System.Net.WebSockets.ClientWebSocket ws = new System.Net.WebSockets.ClientWebSocket();
ws.Options.KeepAliveInterval = TimeSpan.FromSeconds(0); // Pong 전송 코드 수행을 막기 위해 일부러 0으로 설정

await ws.ConnectAsync(new Uri(url), connectTimeout.Token);

if (ws.State != System.Net.WebSockets.WebSocketState.Open)
{
    Console.WriteLine($"Failed to connect: {url}");
    return;
}

_ = Task.Run(() =>
{
    WebSocket? managedSocket = GetManagedSocket(ws);
    if (managedSocket == null)
    {
        return;
    }

    while (true)
    {
        SendKeepAliveFrame(managedSocket);
        Thread.Sleep(5000);
    }
});

끝입니다. 잘 동작하는지 확인을 위해 nodejs 서버 코드에 로그를 남겨 보면,

var { WebSocketServer } = require('ws')

const sockserver = new WebSocketServer({ port: 18000 })

sockserver.on('connection', ws => {
    interval_id = 0;

    console.log('New client connected!')

    ws.send('connection established')

    ws.on('ping', () => {
        console.log('ping received from client');
    });

    // ...[생략]...
})

정상적으로 "ping received ..." 메시지가 출력되는 것을 볼 수 있습니다. 당연히 nodejs는 저렇게 ping을 수신하면 응답으로 pong을 다시 클라이언트로 전송하게 될 것입니다. 아쉽게도 수신 여부를 ClientWebSocket으로 알 수는 없지만, 비주얼 스튜디오의 닷넷 소스코드 디버깅 기능을 이용하면,

비주얼 스튜디오 2022를 이용한 (소스 코드가 없는) 닷넷 모듈 디버깅 - "외부 원본(External Sources)"
; https://www.sysnet.pe.kr/2/0/13109

ReceiveAsyncPrivate 메서드 내부의 MessageOpcode.Pong 조건절에 BP를 설정해 확인해 볼 수는 있습니다.

[AsyncMethodBuilder(typeof(PoolingAsyncValueTaskMethodBuilder<>))]
private async ValueTask ReceiveAsyncPrivate(Memory payloadBuffer, CancellationToken cancellationToken)
{
    // ...[생략]...

    while (true) // in case we get control frames that should be ignored from the user's perspective
    {
        // ...[생략]...
        await _stream.ReadAsync(Memory.Empty, cancellationToken).ConfigureAwait(false);

        // ...[생략]...
        string? headerErrorMessage = TryParseMessageHeaderFromReceiveBuffer(out header);

        // 아래의 코드에 Breakpoint 설정
        if (header.Opcode == MessageOpcode.Ping || header.Opcode == MessageOpcode.Pong)
        {
            await HandleReceivedPingPongAsync(header, cancellationToken).ConfigureAwait(false);
            continue;
        }

        // ...[생략]...
    }

    // ...[생략]...
}

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 1/10/2024]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13558정성태2/18/20243479닷넷: 2217. C# - 최댓값이 1인 SemaphoreSlim 보다 Mutex 또는 lock(obj)를 선택하는 것이 나은 이유
13557정성태2/18/20243196Windows: 258. Task Scheduler의 Author 속성 값을 변경하는 방법
13556정성태2/17/20243296Windows: 257. Windows - Symbolic (hard/soft) Link 및 Junction 차이점
13555정성태2/15/20243585닷넷: 2216. C# - SemaphoreSlim 사용 시 주의점
13554정성태2/15/20243174VS.NET IDE: 189. Visual Studio - 닷넷 소스코드 디컴파일 찾기가 안 될 때
13553정성태2/14/20243228닷넷: 2215. windbg - thin/fat lock 없이 동작하는 Monitor.Wait + Pulse
13552정성태2/13/20243257닷넷: 2214. windbg - Monitor.Enter의 thin lock과 fat lock
13551정성태2/12/20243618닷넷: 2213. ASP.NET/Core 웹 응용 프로그램 - 2차 스레드의 예외로 인한 비정상 종료
13550정성태2/11/20243837Windows: 256. C# - Server socket이 닫히면 Accept 시켰던 자식 소켓이 닫힐까요?
13549정성태2/3/20244086개발 환경 구성: 706. C# - 컨테이너에서 실행하기 위한 (소켓) 콘솔 프로젝트 구성
13548정성태2/1/20243780개발 환경 구성: 705. "Docker Desktop for Windows" - ASP.NET Core 응용 프로그램의 소켓 주소 바인딩(IPv4/IPv6 loopback, Any)
13547정성태1/31/20243525개발 환경 구성: 704. Visual Studio - .NET 8 프로젝트부터 dockerfile에 추가된 "USER app" 설정
13546정성태1/30/20243279Windows: 255. (디버거의 영향 등으로) 대상 프로세스가 멈추면 Socket KeepAlive로 연결이 끊길까요?
13545정성태1/30/20243063닷넷: 2212. ASP.NET Core - 우선순위에 따른 HTTP/HTTPS 호스트:포트 바인딩 방법
13544정성태1/30/20243182오류 유형: 894. Microsoft.Data.SqlClient - Could not load file or assembly 'System.Security.Permissions, ...'
13543정성태1/30/20243250Windows: 254. Windows - 기본 사용 중인 5357 포트 비활성화는 방법
13542정성태1/30/20243116오류 유형: 893. Visual Studio - Web Application을 실행하지 못하는 IISExpress - 두 번째 이야기
13541정성태1/29/20243344VS.NET IDE: 188. launchSettings.json의 useSSL 옵션
13540정성태1/29/20243517Linux: 69. 리눅스 - "Docker Desktop for Windows" Container 환경에서 IPv6 Loopback Address 바인딩 오류
13539정성태1/26/20243453개발 환경 구성: 703. Visual Studio - launchSettings.json을 이용한 HTTP/HTTPS 포트 바인딩
13538정성태1/25/20243797닷넷: 2211. C# - NonGC(FOH) 영역에 .NET 개체를 생성파일 다운로드1
13537정성태1/24/20243913닷넷: 2210. C# - Native 메모리에 .NET 개체를 생성파일 다운로드1
13536정성태1/23/20243898닷넷: 2209. .NET 8 - NonGC Heap / FOH (Frozen Object Heap) [1]
13535정성태1/22/20243875닷넷: 2208. C# - GCHandle 구조체의 메모리 분석
13534정성태1/21/20243682닷넷: 2207. C# - SQL Server DB를 bacpac으로 Export/Import파일 다운로드1
13533정성태1/18/20243781닷넷: 2206. C# - TCP KeepAlive의 서버 측 구현파일 다운로드1
1  2  3  4  5  [6]  7  8  9  10  11  12  13  14  15  ...