XmobiTea.ProtonNetServer 1.0.4

dotnet add package XmobiTea.ProtonNetServer --version 1.0.4                
NuGet\Install-Package XmobiTea.ProtonNetServer -Version 1.0.4                
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="XmobiTea.ProtonNetServer" Version="1.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XmobiTea.ProtonNetServer --version 1.0.4                
#r "nuget: XmobiTea.ProtonNetServer, 1.0.4"                
#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 XmobiTea.ProtonNetServer as a Cake Addin
#addin nuget:?package=XmobiTea.ProtonNetServer&version=1.0.4

// Install XmobiTea.ProtonNetServer as a Cake Tool
#tool nuget:?package=XmobiTea.ProtonNetServer&version=1.0.4                

XmobiTea.ProtonNetServer

Project Overview

XmobiTea.ProtonNetServer is a lightweight, high-performance TCP, UDP, and WebSocket server library for .NET. It provides a flexible and scalable solution for building custom servers, handling thousands of simultaneous connections with ease. The library supports secure connections using SSL/TLS and is designed to be easily extensible, allowing developers to implement custom protocols and behaviors.

Installation

To install XmobiTea.ProtonNetServer, you can use NuGet:

dotnet add package XmobiTea.ProtonNetServer

Or via the NuGet Package Manager in Visual Studio:

  1. Right-click on your project in Solution Explorer and select "Manage NuGet Packages".
  2. Search for XmobiTea.ProtonNetServer.
  3. Click "Install".

Features

  • TCP, UDP, and WebSocket Support: Provides robust implementations for TCP, UDP, and WebSocket protocols.
  • SSL/TLS Support: Secure your connections with SSL/TLS using built-in support for secure protocols.
  • High Performance: Optimized for handling thousands of simultaneous connections efficiently.
  • Extensible Architecture: Easily extend and customize the server to support custom protocols and behaviors.
  • Asynchronous Operations: Fully supports asynchronous I/O operations, ensuring scalability and responsiveness.
  • Session Management: Built-in session management for maintaining state across connections.
  • Network Statistics: Monitor network activity with detailed statistics for sent and received data.

Usage

Basic TCP Server

using XmobiTea.ProtonNetServer;
using XmobiTea.ProtonNetServer.Options;

var options = new TcpServerOptions
{
    ReceiveBufferCapacity = 1024,
    SendBufferCapacity = 1024,
    KeepAlive = true
};

var server = new TcpServer("127.0.0.1", 9000, options);

server.Start();

Console.WriteLine("Server started on 127.0.0.1:9000");
Console.ReadLine();

server.Stop();

WebSocket Server with SSL

using XmobiTea.ProtonNetServer;
using XmobiTea.ProtonNetServer.Options;
using XmobiTea.ProtonNetServer.Ssl;

var sslOptions = new SslOptions("server.pfx", "password");
var options = new TcpServerOptions
{
    NoDelay = true,
    TcpKeepAliveTime = 60,
    TcpKeepAliveInterval = 30,
    TcpKeepAliveRetryCount = 5
};

var server = new WssServer("127.0.0.1", 9001, options, sslOptions);

server.Start();

Console.WriteLine("Secure WebSocket server started on wss://127.0.0.1:9001");
Console.ReadLine();

server.Stop();

Supported Data Types

  • TcpServerOptions: Configuration options for TCP servers.
  • UdpServerOptions: Configuration options for UDP servers.
  • WebSocket: A class representing a WebSocket connection, supporting text and binary frames.
  • SslOptions: SSL/TLS options for secure connections.

Extensibility

XmobiTea.ProtonNetServer is designed with extensibility in mind. You can extend its functionality by:

  • Custom Sessions: Inherit from TcpSession, UdpSession, or WsSession to create custom session handling logic.
  • Custom Protocols: Implement custom protocol handling by overriding the OnReceived method in your session classes.
  • Server Events: Override server lifecycle methods like OnStarting, OnStopping, OnError, etc., to add custom behavior.

Contributing

Contributions to XmobiTea.ProtonNetServer are welcome! Please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Commit your changes with clear and concise messages.
  4. Open a pull request to the main branch.

License

XmobiTea.ProtonNetServer is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

Special thanks to the open-source community for their contributions and continuous support.

Product 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 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net46 is compatible.  net461 is compatible.  net462 is compatible.  net463 was computed.  net47 is compatible.  net471 is compatible.  net472 is compatible.  net48 is compatible.  net481 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on XmobiTea.ProtonNetServer:

Package Downloads
XmobiTea.ProtonNet.Server

XmobiTea.ProtonNet.Server is core of both SocketServer and WebApiServer.

GitHub repositories

This package is not used by any popular GitHub repositories.