TCPMaid 3.0.0
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.1
This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
dotnet add package TCPMaid --version 3.0.0
NuGet\Install-Package TCPMaid -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TCPMaid" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TCPMaid --version 3.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TCPMaid, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TCPMaid as a Cake Addin #addin nuget:?package=TCPMaid&version=3.0.0 // Install TCPMaid as a Cake Tool #tool nuget:?package=TCPMaid&version=3.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
TCPMaid
An easy, powerful and lightweight TCP client/server in C#.
TCPMaid makes it easy to setup a robust client & server, send messages and requests, and provide your own SSL certificate.
Features
- Easy client & server setup
- Supports SSL encryption and certificates
- Automatically serialises messages to bytes
- Automatically fragments large messages to avoid congestion
- Supports requests and responses
- Supports IPv4 and IPv6
Dependencies
Example
Client
public static async void Client() {
// Connect client to server
ClientMaid Client = new();
await Client.ConnectAsync("localhost", 5000);
// Say hello to server
await Client.Channel!.SendAsync(new ExampleMessage("hello server!"));
}
Server
public static void Server() {
// Start server on port 5000
ServerMaid Server = new();
Server.Start(5000);
// Listen to events
Server.OnConnect += OnConnect;
Server.OnReceive += OnReceive;
// Events
void OnConnect(Channel Client) {
Console.WriteLine("Hi, client!");
}
void OnReceive(Channel Client, Message Message) {
if (Message is ExampleMessage ExampleMessage) {
Console.WriteLine($"Received '{ExampleMessage.ExampleText}' from client!");
}
}
}
Shared
[MemoryPackable]
public partial class ExampleMessage(string ExampleText) : Message {
public readonly string ExampleText = ExampleText;
}
Output
Hi, client!
Received 'hello server!' from client!
Requests
The client may want to ask the server for data. To send a message and wait for a response, you can use RequestAsync
.
Client
// Send an ExampleRequest and wait for an ExampleResponse with the same message ID
ExampleResponse? Response = await Client.Channel!.RequestAsync<ExampleResponse>(new ExampleRequest());
Console.WriteLine(Response!.ExampleText);
Server
Server.OnReceive += (Channel, Message) => {
if (Message is ExampleRequest ExampleRequest) {
_ = Channel.SendAsync(new ExampleResponse(ExampleRequest.Id, "Here's my response: -.-"));
}
};
Shared
[MemoryPackable]
public partial class ExampleRequest : Message {
}
[MemoryPackable]
public partial class ExampleResponse(long Id, string ExampleText) : Message(Id) {
public readonly string ExampleText = ExampleText;
}
Output
Here's my response: -.-
Streams
You may want to send a large file without keeping it all in memory. To send data from a stream, you can use SendStreamAsync
and ReceiveStreamAsync
.
Sender
using FileStream Reader = File.OpenRead("Cat.png");
await Channel.SendStreamAsync("Cat Picture", Reader);
Receiver
using FileStream Writer = File.OpenWrite("Cat.png");
await Channel.ReceiveStreamAsync("Cat Picture", Writer);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.1
- MemoryPack (>= 1.21.3)
-
net6.0
- MemoryPack (>= 1.21.3)
-
net7.0
- MemoryPack (>= 1.21.3)
-
net8.0
- MemoryPack (>= 1.21.3)
-
net9.0
- MemoryPack (>= 1.21.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
3.0.0 | 75 | 12/7/2024 | |
2.4.1 | 150 | 4/13/2024 | |
2.4.0 | 110 | 3/31/2024 | |
2.3.0 | 107 | 3/30/2024 | |
2.2.0 | 118 | 3/29/2024 | |
2.1.1 | 131 | 3/17/2024 | |
2.1.0 | 130 | 3/7/2024 | |
2.0.4 | 137 | 3/3/2024 | |
1.0.7 | 119 | 2/22/2024 | |
1.0.6 | 127 | 2/20/2024 | |
1.0.5 | 140 | 2/18/2024 | |
1.0.4 | 145 | 2/17/2024 | |
1.0.3 | 138 | 2/7/2024 | |
1.0.2 | 132 | 2/5/2024 | |
1.0.1 | 126 | 1/22/2024 |