ElectronCgi.DotNet 1.0.3

.NET Standard 2.0
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package ElectronCgi.DotNet --version 1.0.3
NuGet\Install-Package ElectronCgi.DotNet -Version 1.0.3
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="ElectronCgi.DotNet" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ElectronCgi.DotNet --version 1.0.3
#r "nuget: ElectronCgi.DotNet, 1.0.3"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ElectronCgi.DotNet as a Cake Addin
#addin nuget:?package=ElectronCgi.DotNet&version=1.0.3

// Install ElectronCgi.DotNet as a Cake Tool
#tool nuget:?package=ElectronCgi.DotNet&version=1.0.3

Electron CGI

Electron CGI is a library that enables sending request form NodeJs and have them served by .NET.

The npm package is called electron-cgi.

The nuget package is called ElectronCgi.DotNet.

Here's an example of how you can interact with a .Net application from Node:

In NodeJs/Electron:

const { ConnectionBuilder } = require('electron-cgi');

const connection = new ConnectionBuilder()
        .connectTo('dotnet', 'run', '--project', 'DotNetConsoleProjectWithElectronCgiDotNetNugetPackage')
        .build();

connection.onDisconnect = () => {
    console.log('Lost connection to the .Net process');
};

connection.send('greeting', 'John', (err, theGreeting) => {
    if (err) {
        console.log(err);
        return;
    }
    console.log(theGreeting); // will print "Hello John!"
});

//or using promises

const theGreeting = await connection.send('greeting', 'John')

connection.close();

And in the .Net Console Application:

using ElectronCgi.DotNet;

//...
static void Main(string[] args)
{
    var connection = new ConnectionBuilder()
                        .WithLogging()
                        .Build();

    // expects a request named "greeting" with a string argument and returns a string
    connection.On<string, string>("greeting", name =>
    {
        return $"Hello {name}!";
    });

    // wait for incoming requests
    connection.Listen();        
}

How does it work?

Electron CGI establishes a "connection" with an external process. That external process must be configured to accept that connection. In the example above that's what the Listen method does.

In Node we can "send" requests (for example "greeting" with "John" as a parameter) and receive a response from the other process.

The way this communication channel is established is by using the connected process' stdin and stdout streams. This approach does not rely on staring up a web server and because of that introduces very little overhead in terms of the requests' round-trip time.

Changelog

Update version 1.0.3

Bugfix for Connection.Send(requestType, arg, responseArg => {...}) where argument type information for the response argument type was being inadvertently discarded.

Update version 1.0.2

Added the the UsingEncoding(System.Text.Encoding encoding) method to ConnectionBuilder, usage:

var connection = new ConnectionBuilder().UsingEncoding(System.Text.Encoding.UTF8).Build()

If you are having encoding issues with messages between Node and .NET failing because of special characters (e.g. ä,ö,ü) try to set the encoding this way in .NET.

Update version 1.0.1

  • Error propagation to Node.js

    • An exception in a handler will be serialized and sent to Node.js (requires electron-cgi 1.0.0) and won't crash the process
  • Bugfixes

Update version 1.0.0

  • This version was uploaded incorrectly. Skip it.

Update version 0.0.5

  • Duplex: ability to send requests from both .Net and Node.js

Update version 0.0.2

  • Ability to serve request concurrently (uses System.Threading.Tasks.DataFlow)

Next steps

  • Add the ability to send requests form .Net to Node
  • Instead of making the process fail when there's an exception in a handler, serialise the exception and "surface" it in Node

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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
1.0.4-beta 408 11/7/2020
1.0.3 18,203 6/15/2020
1.0.2 492 5/31/2020
1.0.1 2,991 3/9/2020
1.0.0 363 3/5/2020
0.0.5 1,230 11/25/2019
0.0.2 1,297 3/20/2019
0.0.1 1,020 2/16/2019

Bugfix for Send losing response arg type information