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;
}
// ...[생략]...
}
// ...[생략]...
}
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]