-
-
Notifications
You must be signed in to change notification settings - Fork 363
feat(ITcpSocketClient): add TouchSocket extensions #6268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
8cf8794
chore: 更新解决方案增加扩展包
ArgoZhang c31b545
feat: 增加 ReceivedCallBack 回调方法
ArgoZhang 7c39c48
test: 增加单元测试
ArgoZhang 081236b
doc: 更新示例文档
ArgoZhang 712e0dc
test: 增加 TouchSocket 单元测试
ArgoZhang d32f100
doc: 更新粘包分包文档
ArgoZhang 4e78aba
feat: 增加 SendAsync 扩展方法
ArgoZhang 52334b7
test: 增加单元测试
ArgoZhang a533852
Merge branch 'main' into feat-TouchSocket
ArgoZhang 859b0cc
feat(tcp): 替换同步关闭方法为异步方法
RRQM 82a93f4
refactor(tests): 使用异步方法关闭连接
RRQM 517dc1f
doc: 更新数据处理器相关文档
ArgoZhang 0f328a3
refactor: 增加 ConnectAsync 扩展方法
ArgoZhang 336dd47
refactor: 更改关闭方法为同步方法
ArgoZhang 93f68b6
test: 更新单元测试
ArgoZhang 686e03b
Merge branch 'main' into feat-TouchSocket
ArgoZhang e23296f
doc: 增加数据适配器文档
ArgoZhang 0f86b3c
doc: 增加新服务标记
ArgoZhang a2767ab
refactor: 更新 ITcpSocketFactory 接口定义
ArgoZhang 60552bb
feat: 增加 GetOrCreate 扩展方法
ArgoZhang 544fcd2
test: 更新单元测试
ArgoZhang d132af3
test: 增加单元测试
ArgoZhang 66ab098
Merge branch 'main' into feat-TouchSocket
ArgoZhang 0edee26
refactor: 更改 GetOrCreate 签名
ArgoZhang 03bf822
test: 更新单元测试
ArgoZhang 86a0333
refactor: 根据最新设计重构 TouchSocket 实现
ArgoZhang a97bc71
refactor: 整理项目文件
ArgoZhang 7fc2eb1
Merge branch 'main' into feat-TouchSocket
ArgoZhang cc1a7ef
wip: 临时移除稍后再开分支合并到另外分支上
ArgoZhang 1edbe34
chore: bump version 9.7.4-beta08
ArgoZhang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
src/BootstrapBlazor/Extensions/ITcpSocketClientExtensions.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the Apache 2.0 License | ||
| // See the LICENSE file in the project root for more information. | ||
| // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone | ||
|
|
||
| using System.Text; | ||
|
|
||
| namespace BootstrapBlazor.Components; | ||
|
|
||
| /// <summary> | ||
| /// <see cref="ITcpSocketClient"/> 扩展方法类 | ||
| /// </summary> | ||
| public static class ITcpSocketClientExtensions | ||
| { | ||
| /// <summary> | ||
| /// Sends the specified string content to the connected TCP socket client asynchronously. | ||
| /// </summary> | ||
| /// <remarks>This method converts the provided string content into a byte array using the specified | ||
| /// encoding (or UTF-8 by default) and sends it to the connected TCP socket client. Ensure the client is connected | ||
| /// before calling this method.</remarks> | ||
| /// <param name="client">The TCP socket client to which the content will be sent. Cannot be <see langword="null"/>.</param> | ||
| /// <param name="content">The string content to send. Cannot be <see langword="null"/> or empty.</param> | ||
| /// <param name="encoding">The character encoding to use for converting the string content to bytes. If <see langword="null"/>, UTF-8 | ||
| /// encoding is used by default.</param> | ||
| /// <param name="token">A <see cref="CancellationToken"/> to observe while waiting for the operation to complete.</param> | ||
| /// <returns>A <see cref="ValueTask{TResult}"/> that represents the asynchronous operation. The result is <see | ||
| /// langword="true"/> if the content was sent successfully; otherwise, <see langword="false"/>.</returns> | ||
| public static ValueTask<bool> SendAsync(this ITcpSocketClient client, string content, Encoding? encoding = null, CancellationToken token = default) | ||
| { | ||
| var buffer = encoding?.GetBytes(content) ?? Encoding.UTF8.GetBytes(content); | ||
| return client.SendAsync(buffer, token); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the Apache 2.0 License | ||
| // See the LICENSE file in the project root for more information. | ||
| // Maintainer: Argo Zhang([email protected]) Website: https://www.blazor.zone | ||
|
|
||
| using Microsoft.Extensions.Logging; | ||
| using System.Net; | ||
| using System.Net.Sockets; | ||
|
|
||
| namespace UnitTest.Services; | ||
|
|
||
| public class TouchSocketTest | ||
| { | ||
| [Fact] | ||
| public async Task FixLengthDataPackageHandler_Ok() | ||
| { | ||
| var port = 8884; | ||
| var server = StartTcpServer(port, MockSplitPackageAsync); | ||
| var client = CreateClient(); | ||
|
|
||
| // 测试 ConnectAsync 方法 | ||
| var connect = await client.ConnectAsync("localhost", port); | ||
| Assert.True(connect); | ||
| Assert.True(client.IsConnected); | ||
|
|
||
| var tcs = new TaskCompletionSource(); | ||
| ReadOnlyMemory<byte> receivedBuffer = ReadOnlyMemory<byte>.Empty; | ||
|
|
||
| // 增加数据处理适配器 | ||
| client.SetDataHandler(new FixLengthDataPackageHandler(7) | ||
| { | ||
| ReceivedCallBack = buffer => | ||
| { | ||
| receivedBuffer = buffer; | ||
| tcs.SetResult(); | ||
| return ValueTask.CompletedTask; | ||
| } | ||
| }); | ||
|
|
||
| // 测试 SendAsync 方法 | ||
| var data = new ReadOnlyMemory<byte>([1, 2, 3, 4, 5]); | ||
| var result = await client.SendAsync(data); | ||
| Assert.True(result); | ||
|
|
||
| await tcs.Task; | ||
| Assert.Equal(receivedBuffer.ToArray(), [1, 2, 3, 4, 5, 3, 4]); | ||
|
|
||
| // 模拟延时等待内部继续读取逻辑完成,测试内部 _receiveCancellationTokenSource 取消逻辑 | ||
| await Task.Delay(10); | ||
|
|
||
| // 关闭连接 | ||
| client.Close(); | ||
| StopTcpServer(server); | ||
| } | ||
|
|
||
| private static async Task MockSplitPackageAsync(TcpClient client) | ||
| { | ||
| using var stream = client.GetStream(); | ||
| while (true) | ||
| { | ||
| var buffer = new byte[10240]; | ||
| var len = await stream.ReadAsync(buffer); | ||
| if (len == 0) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| // 回写数据到客户端 | ||
| var block = new ReadOnlyMemory<byte>(buffer, 0, len); | ||
| await stream.WriteAsync(block, CancellationToken.None); | ||
|
|
||
| // 模拟延时 | ||
| await Task.Delay(50); | ||
|
|
||
| // 模拟拆包发送第二段数据 | ||
| await stream.WriteAsync(new byte[] { 0x3, 0x4 }, CancellationToken.None); | ||
| } | ||
| } | ||
|
|
||
| private static TcpListener StartTcpServer(int port, Func<TcpClient, Task> handler) | ||
| { | ||
| var server = new TcpListener(IPAddress.Loopback, port); | ||
| server.Start(); | ||
| Task.Run(() => AcceptClientsAsync(server, handler)); | ||
| return server; | ||
| } | ||
|
|
||
| private static async Task AcceptClientsAsync(TcpListener server, Func<TcpClient, Task> handler) | ||
| { | ||
| while (true) | ||
| { | ||
| var client = await server.AcceptTcpClientAsync(); | ||
| _ = Task.Run(() => handler(client)); | ||
| } | ||
| } | ||
|
|
||
| private static void StopTcpServer(TcpListener server) | ||
| { | ||
| server?.Stop(); | ||
| } | ||
|
|
||
| private static ITcpSocketClient CreateClient() | ||
| { | ||
| var sc = new ServiceCollection(); | ||
| sc.AddLogging(builder => | ||
| { | ||
| builder.AddProvider(new MockLoggerProvider()); | ||
| }); | ||
| sc.AddBootstrapBlazorTcpSocketFactory(); | ||
|
|
||
| // 增加 TouchSocket 服务 | ||
| sc.AddBootstrapBlazorTouchSocketService(); | ||
|
Check failure on line 112 in test/UnitTest/Services/TouchSocketTest.cs
|
||
|
|
||
| var provider = sc.BuildServiceProvider(); | ||
| var factory = provider.GetRequiredService<ITcpSocketFactory>(); | ||
| var client = factory.GetOrCreate("localhost", 0); | ||
| return client; | ||
| } | ||
|
|
||
| class MockLoggerProvider : ILoggerProvider | ||
| { | ||
| public ILogger CreateLogger(string categoryName) | ||
| { | ||
| return new MockLogger(); | ||
| } | ||
|
|
||
| public void Dispose() | ||
| { | ||
|
|
||
| } | ||
| } | ||
|
|
||
| class MockLogger : ILogger | ||
| { | ||
| public IDisposable? BeginScope<TState>(TState state) where TState : notnull | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| public bool IsEnabled(LogLevel logLevel) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter) | ||
| { | ||
|
|
||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.