SharpOpenNat 4.0.4
dotnet add package SharpOpenNat --version 4.0.4
NuGet\Install-Package SharpOpenNat -Version 4.0.4
<PackageReference Include="SharpOpenNat" Version="4.0.4" />
paket add SharpOpenNat --version 4.0.4
#r "nuget: SharpOpenNat, 4.0.4"
// Install SharpOpenNat as a Cake Addin #addin nuget:?package=SharpOpenNat&version=4.0.4 // Install SharpOpenNat as a Cake Tool #tool nuget:?package=SharpOpenNat&version=4.0.4
SharpOpenNat
SharpOpenNat is a lightweight and easy-to-use class library to allow port forwarding in NAT devices that support UPNP (Universal Plug & Play) and/or PMP (Port Mapping Protocol).
Build Status
Goals
NATed computers cannot be reached from outside and this is particularly painful for peer-to-peer or friend-to-friend software. The main goal is to simplify communication amoung computers behind NAT devices that support UPNP and/or PMP providing a clean and easy interface to get the external IP address and map ports and helping you to achieve peer-to-peer communication.
- Tested with .NET YES
How to use?
With nuget :
Install-Package SharpOpenNat
Go on the nuget website for more information.
Example
The simplest scenario:
var device = await NatDiscoverer.DiscoverDeviceAsync();
var ip = await device.GetExternalIPAsync();
Console.WriteLine("The external IP Address is: {0} ", ip);
The following piece of code shows a common scenario: It starts the discovery process for a NAT-UPNP device and onces discovered it creates a port mapping. If no device is found before ten seconds, it fails with NatDeviceNotFoundException.
var cts = new CancellationTokenSource(10000);
var device = await NatDiscoverer.DiscoverDeviceAsync(PortMapper.Upnp, cts);
await device.CreatePortMapAsync(new Mapping(Protocol.Tcp, 1600, 1700, "The mapping name"));
Documentation
- Why Open.NAT? Here you have ten reasons that make Open.NAT a good candidate for you projects
- Visit the Wiki page
Development
You are welcome to contribute code. You can send code both as a patch or a GitHub pull request.
Description | Value |
---|---|
License | The MIT License (MIT) |
Documentation | http://jeremyansel.github.io/SharpOpenNat |
Source code | https://github.com/JeremyAnsel/SharpOpenNat |
Nuget | https://www.nuget.org/packages/SharpOpenNat |
Build | https://ci.appveyor.com/project/JeremyAnsel/sharpopennat/branch/main |
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 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 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 is compatible. net481 was computed. |
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. |
-
.NETFramework 4.8
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
-
net6.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (2)
Showing the top 2 NuGet packages that depend on SharpOpenNat:
Package | Downloads |
---|---|
sparrow-cert
SparrowCert is a simple certificate renewal library for Kestrel-based services. It can be used in any .NET Core-based web service. The service automatically renews certificates, eliminating the need to worry about certificate expiry. |
|
sparrow-upnp
Sparrow.UPnP is a simple UPnP library for .NET Core. It can be used in any .NET Core-based service. The library automatically discovers UPnP devices on the network and provides a simple interface for interacting with them. |
GitHub repositories
This package is not used by any popular GitHub repositories.