magic.signals.contracts 17.1.7

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

// Install magic.signals.contracts as a Cake Tool
#tool nuget:?package=magic.signals.contracts&version=17.1.7

magic.signals - Super signals for Hyperlambda

magic.signals is a "Super Signals" implementation for .Net 8 built on top of magic.node, allowing you to invoke functions from one assembly in another assembly without having any direct references between your projects.

Active Events or Super Signals internals

Zero cross project references is made possible by always having a YALOA, allowing us to invoke methods in classes through a "magic string", which references a type in a dictionary, where the string is its key, and the types are dynamically loaded during startup of your AppDomain. Imagine the following code.

[Slot(Name = "foo.bar")]
public class FooBar : ISlot
{
    public void Signal(ISignaler signaler, Node input)
    {
        input.Value = 42;
    }
}

The above declares a "slot" for the signal [foo.bar]. In any other place in our AppDomain we can use an ISignaler instance to Signal the above slot by using something such as the following.

/*
 * This will invoke our Signal method above
 */
var args = new Node();
signaler.Signal("foo.bar", args);

/*
 * The value of args is now 42.
 */
Assert.Equal(42, args.Value);

Notice that there are no shared types between the invoker and the handler, and there are no references necessary to be shared between these two assemblies. This results in an extremely loosely coupled plugin architecture, where you can dynamically add any plugin you wish into your AppDomain, by simply referencing whatever plugin assembly you wish to bring into your AppDomain, and immediately start consuming your plugin's functionality - Or dynamically loading it during runtime for that matter, resulting in that you instantly have access to its slots, without needing to create cross projects references in any ways.

This results in an extremely loosely coupled architecture of related components, where any one component can easily be exchanged with any other component, as long as it is obeying by the implicit interface of the component you're replacing. Completely eliminating "strongly typing", making interchanging components with other components equally simply in a static programming language such as the .Net CLR as providing a function object in JavaScript.

In many ways, this results in having all the advantages from a functional programming language in a static programming language, while still keeping the strongly typing around for cases where you need strongly typing - Allowing you to choose which paradigm you want to use, based upon individual use cases, and not having the language and platform dictate your choices in these regards.

The magic.signals implementation uses IServiceProvider to instantiate your above FooBar class when it wants to evaluate your slot. This makes it behave as a good IoC citizen, allowing you to pass in for instance interfaces into your constructor, and have the .Net dependency injection automatically create objects of whatever interface your slot implementation requires.

There is also an async version of the interface, which allows you to declare async slots, transparently letting the runtime choose which implementation to use, depending upon whether or not it is currently in an async execution context or not. Below you can see how to accomplish the same as above, except this time the slot will be invoked within an async context.

[Slot(Name = "foo.bar")]
public class FooBar : ISlotAsync
{
    public Task SignalAsync(ISignaler signaler, Node input)
    {
        input.Value = 42;
        await Task.Yield();
    }
}

It's a common practice to implements slots that recursively invokes other slots, by combining the above two constructs, into one single class. Below is an example.

[Slot(Name = "foo.bar")]
public class FooBar : ISlot, ISlotAsync
{
    // Sync version.
    public void Signal(ISignaler signaler, Node input)
    {
        input.Value = 42;
    }

    // Async version.
    public async Task SignalAsync(ISignaler signaler, Node input)
    {
        input.Value = 42;
        await Task.Yield();
    }
}

The above simple example is probably not that useful to implement as an async slot, but for other parts of your code, where you for instance are accessing sockets, HTTP connections, or the file system for that matter - Creating async slots will have huge advantages for your application's ability to scale, and handle multiple simultaneous users and connections. The runtime will "automagically" choose the correct implementation, being synchronous or asynchronous, depending upon which execution context the execution object currently is within.

If your slots recursively invokes other slots, by for instance invoking signaler.Signal("eval", args), you should also implement the async interface, to allow for children lambda objects to be within an async context. This has huge advantages for your application's throughput.

Passing arguments to your slots

The Node class provides a graph object for you, allowing you to automagically pass in any arguments you wish. Notice, the whole idea is to de-couple your assemblies, hence you shouldn't really pass in anything but native types, such as for instance System.String, System.DateTime, integers, etc. However, most complex POD structures, can also easily be represented using this Node class.

The Node class is basically a name/value/children graph object, where the value can be any object, the name a string, and children is a list of children Nodes. In such a way, it provides a more C# friendly graph object, kind of resembling JSON, allowing you to internally within your assemblies, pass in a Node object as your parameters from the point of your signal, to the slot where you handle the signal.

The Node POCO class again, is a bi-directional POD instance, allowing you to both pass arguments into the slot, in addition to having the slot return values back to the caller.

If you invoke Signal or SignalAsync from C#, you can optionally pass in a function object that will be executed after the signal has been executed. This is useful for cases where you're creating an async signal invocation, but not invoking it immediately, and rather returning it as a Task to some other parts of your system, to ensure something occurs after the signal has been executed. Below is an example.

var args = new Node();
return signaler.SignalAsync("foo.bar", args, () => { /* ... This will happen AFTER execution of signal ... */ });

Magic Signals a DSL

A lot of the idea behind Magic Signals is that combined with magic.node, and especially its ability to parse Hyperlambda, it becomes a very good foundation for a DSL, or a Domain Specific programming Language implementation, allowing you to easily create your own programming languages, and keywords, based upon Hyperlambda syntax trees. Hyperlambda in this context being the textual representation of your Node hierarchy.

Project website for magic.signals

The source code for this repository can be found at github.com/polterguy/magic.signals, and you can provide feedback, provide bug reports, etc at the same place.

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Coverage
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities

The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (32)

Showing the top 5 NuGet packages that depend on magic.signals.contracts:

Package Downloads
magic.data.common

A generic and dynamic SQL data adapter, allowing you to generate SQL dialects, specific to your database type, such as MySQL or SQL Server. This is the core base class data adapter for Magic. To use package go to https://polterguy.github.io

magic.signals

A Super Signals implementation for Magic built on magic.node, allowing you to invoke functionality from one component in another component without any (direct) references between your components. To use package go to https://polterguy.github.io

magic.endpoint.services

Service implementations for magic.endpoint, that allows you to dynamically evaluate Hyperlambda files associated with a URL. To use package go to https://polterguy.github.io

magic.lambda.logging

Logging helper slots for Magic, allowing you to inject your own logging implementation, giving you the ability to create log entries from Hyperlambda. To use package go to https://polterguy.github.io

magic.endpoint

Magic endpoint is a dynamic Hyperlambda endpoint evaluator, allowing you to create HTTP REST API endpoints dynamically, that will execute a Hyperlambda file when evaluated, where the URL is a reference to the physical path on disc to your Hyperlambda file. To use package go to https://polterguy.github.io

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
17.1.7 1,641 1/12/2024
17.1.6 1,601 1/11/2024
17.1.5 1,692 1/5/2024
17.0.1 1,768 1/1/2024
17.0.0 2,422 12/14/2023
16.11.5 2,665 11/12/2023
16.9.0 2,726 10/9/2023
16.7.0 3,867 7/11/2023
16.4.1 3,984 7/2/2023
16.4.0 3,936 6/22/2023
16.3.1 4,367 6/6/2023
16.3.0 4,266 5/28/2023
16.1.9 5,484 4/30/2023
15.10.11 5,344 4/13/2023
15.9.1 6,513 3/26/2023
15.9.0 6,151 3/24/2023
15.8.2 6,180 3/20/2023
15.7.0 6,790 3/6/2023
15.5.0 9,826 1/28/2023
15.2.0 8,311 1/18/2023
15.1.0 9,360 12/28/2022
14.5.7 9,274 12/13/2022
14.5.5 9,455 12/6/2022
14.5.1 9,763 11/23/2022
14.5.0 9,862 11/18/2022
14.4.5 11,715 10/22/2022
14.4.1 11,778 10/22/2022
14.4.0 11,558 10/17/2022
14.3.1 14,429 9/12/2022
14.3.0 12,332 9/10/2022
14.1.3 12,647 8/7/2022
14.1.2 12,349 8/7/2022
14.1.1 12,478 8/7/2022
14.0.14 12,552 7/26/2022
14.0.12 12,462 7/24/2022
14.0.11 12,363 7/23/2022
14.0.10 12,360 7/23/2022
14.0.9 12,448 7/23/2022
14.0.8 12,705 7/17/2022
14.0.5 12,430 7/11/2022
14.0.4 12,807 7/6/2022
14.0.3 12,638 7/2/2022
14.0.2 12,504 7/2/2022
14.0.0 13,037 6/25/2022
13.4.0 15,027 5/31/2022
13.3.4 14,305 5/9/2022
13.3.0 14,490 5/1/2022
13.2.0 14,261 4/21/2022
13.1.0 13,582 4/7/2022
13.0.0 12,834 4/5/2022
11.0.5 14,222 3/2/2022
11.0.4 12,876 2/22/2022
11.0.3 12,441 2/9/2022
11.0.2 13,070 2/6/2022
11.0.1 1,164 2/5/2022
11.0.0 12,366 2/5/2022
10.0.21 17,103 1/28/2022
10.0.20 12,908 1/27/2022
10.0.19 12,690 1/23/2022
10.0.18 12,274 1/17/2022
10.0.15 10,109 12/31/2021
10.0.14 7,105 12/28/2021
10.0.7 9,208 12/22/2021
10.0.5 7,620 12/18/2021
9.9.9 9,314 11/29/2021
9.9.3 9,244 11/9/2021
9.9.2 7,608 11/4/2021
9.9.0 8,084 10/30/2021
9.8.9 7,991 10/29/2021
9.8.7 7,930 10/27/2021
9.8.6 7,941 10/27/2021
9.8.5 7,989 10/26/2021
9.8.0 10,315 10/20/2021
9.7.9 8,601 10/19/2021
9.7.5 10,301 10/14/2021
9.7.0 8,206 10/9/2021
9.6.6 1,781 8/14/2021
9.2.0 34,271 5/26/2021
9.1.4 16,142 4/21/2021
9.1.0 8,752 4/14/2021
9.0.0 8,772 4/5/2021
8.9.9 17,225 3/30/2021
8.9.3 9,205 3/19/2021
8.9.2 7,716 1/29/2021
8.9.1 7,893 1/24/2021
8.9.0 8,978 1/22/2021
8.6.9 11,517 11/8/2020
8.6.6 9,760 11/2/2020
8.6.0 12,642 10/28/2020
8.5.0 8,987 10/23/2020
8.4.0 16,574 10/13/2020
8.3.1 9,661 10/5/2020
8.3.0 7,919 10/3/2020
8.2.2 9,431 9/26/2020
8.2.1 7,939 9/25/2020
8.2.0 8,065 9/25/2020
8.1.17 18,313 9/13/2020
8.1.16 1,297 9/13/2020
8.1.15 14,066 9/12/2020
8.1.11 9,878 9/11/2020
8.1.10 8,227 9/6/2020
8.1.9 8,978 9/3/2020
8.1.8 8,160 9/2/2020
8.1.7 7,549 8/28/2020
8.1.4 7,625 8/25/2020
8.1.3 7,719 8/18/2020
8.1.2 7,689 8/16/2020
8.1.1 7,791 8/15/2020
8.1.0 1,166 8/15/2020
8.0.1 14,712 8/7/2020
8.0.0 7,676 8/7/2020
7.0.1 1,168 8/7/2020
7.0.0 13,429 6/28/2020
5.0.0 18,558 2/25/2020
4.0.4 18,972 1/27/2020
4.0.3 7,425 1/27/2020
4.0.2 7,513 1/16/2020
4.0.1 7,466 1/11/2020
4.0.0 7,596 1/5/2020
3.1.0 14,504 11/10/2019
3.0.0 17,500 10/23/2019
2.0.1 18,913 10/15/2019
2.0.0 8,465 10/13/2019
1.1.9 6,937 10/11/2019
1.1.8 8,443 10/10/2019
1.1.7 8,905 10/9/2019
1.1.6 4,019 10/7/2019
1.1.5 8,566 10/6/2019
1.1.3 7,039 10/6/2019
1.1.2 6,082 10/5/2019
1.0.1 5,147 9/26/2019
1.0.0 2,403 9/26/2019