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
<PackageReference Include="magic.signals.contracts" Version="17.1.7" />
paket add magic.signals.contracts --version 17.1.7
#r "nuget: magic.signals.contracts, 17.1.7"
// 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.
Copyright and maintenance
The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.
Product | Versions 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. |
-
.NETStandard 2.0
- magic.node (>= 17.1.7)
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 | 2,136 | 1/12/2024 |
17.1.6 | 2,004 | 1/11/2024 |
17.1.5 | 2,131 | 1/5/2024 |
17.0.1 | 2,164 | 1/1/2024 |
17.0.0 | 2,943 | 12/14/2023 |
16.11.5 | 3,199 | 11/12/2023 |
16.9.0 | 3,197 | 10/9/2023 |
16.7.0 | 4,457 | 7/11/2023 |
16.4.1 | 4,529 | 7/2/2023 |
16.4.0 | 4,422 | 6/22/2023 |
16.3.1 | 4,827 | 6/6/2023 |
16.3.0 | 4,734 | 5/28/2023 |
16.1.9 | 6,009 | 4/30/2023 |
15.10.11 | 5,781 | 4/13/2023 |
15.9.1 | 7,018 | 3/26/2023 |
15.9.0 | 6,610 | 3/24/2023 |
15.8.2 | 6,654 | 3/20/2023 |
15.7.0 | 7,240 | 3/6/2023 |
15.5.0 | 10,369 | 1/28/2023 |
15.2.0 | 8,786 | 1/18/2023 |
15.1.0 | 9,849 | 12/28/2022 |
14.5.7 | 9,734 | 12/13/2022 |
14.5.5 | 9,898 | 12/6/2022 |
14.5.1 | 10,228 | 11/23/2022 |
14.5.0 | 10,326 | 11/18/2022 |
14.4.5 | 12,167 | 10/22/2022 |
14.4.1 | 12,281 | 10/22/2022 |
14.4.0 | 12,003 | 10/17/2022 |
14.3.1 | 14,966 | 9/12/2022 |
14.3.0 | 12,791 | 9/10/2022 |
14.1.3 | 13,122 | 8/7/2022 |
14.1.2 | 12,780 | 8/7/2022 |
14.1.1 | 12,938 | 8/7/2022 |
14.0.14 | 13,010 | 7/26/2022 |
14.0.12 | 12,922 | 7/24/2022 |
14.0.11 | 12,767 | 7/23/2022 |
14.0.10 | 12,795 | 7/23/2022 |
14.0.9 | 12,928 | 7/23/2022 |
14.0.8 | 13,178 | 7/17/2022 |
14.0.5 | 12,865 | 7/11/2022 |
14.0.4 | 13,257 | 7/6/2022 |
14.0.3 | 13,071 | 7/2/2022 |
14.0.2 | 12,956 | 7/2/2022 |
14.0.0 | 13,521 | 6/25/2022 |
13.4.0 | 15,511 | 5/31/2022 |
13.3.4 | 14,821 | 5/9/2022 |
13.3.0 | 14,987 | 5/1/2022 |
13.2.0 | 14,746 | 4/21/2022 |
13.1.0 | 13,970 | 4/7/2022 |
13.0.0 | 13,329 | 4/5/2022 |
11.0.5 | 14,730 | 3/2/2022 |
11.0.4 | 13,384 | 2/22/2022 |
11.0.3 | 12,874 | 2/9/2022 |
11.0.2 | 13,539 | 2/6/2022 |
11.0.1 | 1,214 | 2/5/2022 |
11.0.0 | 12,833 | 2/5/2022 |
10.0.21 | 17,711 | 1/28/2022 |
10.0.20 | 13,349 | 1/27/2022 |
10.0.19 | 13,121 | 1/23/2022 |
10.0.18 | 12,690 | 1/17/2022 |
10.0.15 | 10,696 | 12/31/2021 |
10.0.14 | 7,552 | 12/28/2021 |
10.0.7 | 9,747 | 12/22/2021 |
10.0.5 | 8,058 | 12/18/2021 |
9.9.9 | 9,832 | 11/29/2021 |
9.9.3 | 9,756 | 11/9/2021 |
9.9.2 | 7,990 | 11/4/2021 |
9.9.0 | 8,492 | 10/30/2021 |
9.8.9 | 8,378 | 10/29/2021 |
9.8.7 | 8,363 | 10/27/2021 |
9.8.6 | 8,391 | 10/27/2021 |
9.8.5 | 8,381 | 10/26/2021 |
9.8.0 | 10,836 | 10/20/2021 |
9.7.9 | 9,079 | 10/19/2021 |
9.7.5 | 10,794 | 10/14/2021 |
9.7.0 | 8,623 | 10/9/2021 |
9.6.6 | 1,837 | 8/14/2021 |
9.2.0 | 35,921 | 5/26/2021 |
9.1.4 | 16,810 | 4/21/2021 |
9.1.0 | 9,163 | 4/14/2021 |
9.0.0 | 9,224 | 4/5/2021 |
8.9.9 | 17,882 | 3/30/2021 |
8.9.3 | 9,627 | 3/19/2021 |
8.9.2 | 8,111 | 1/29/2021 |
8.9.1 | 8,307 | 1/24/2021 |
8.9.0 | 9,387 | 1/22/2021 |
8.6.9 | 11,957 | 11/8/2020 |
8.6.6 | 10,212 | 11/2/2020 |
8.6.0 | 13,168 | 10/28/2020 |
8.5.0 | 9,382 | 10/23/2020 |
8.4.0 | 17,227 | 10/13/2020 |
8.3.1 | 10,039 | 10/5/2020 |
8.3.0 | 8,272 | 10/3/2020 |
8.2.2 | 9,872 | 9/26/2020 |
8.2.1 | 8,316 | 9/25/2020 |
8.2.0 | 8,437 | 9/25/2020 |
8.1.17 | 18,970 | 9/13/2020 |
8.1.16 | 1,364 | 9/13/2020 |
8.1.15 | 14,726 | 9/12/2020 |
8.1.11 | 10,298 | 9/11/2020 |
8.1.10 | 8,612 | 9/6/2020 |
8.1.9 | 9,367 | 9/3/2020 |
8.1.8 | 8,541 | 9/2/2020 |
8.1.7 | 7,921 | 8/28/2020 |
8.1.4 | 7,989 | 8/25/2020 |
8.1.3 | 8,090 | 8/18/2020 |
8.1.2 | 8,117 | 8/16/2020 |
8.1.1 | 8,165 | 8/15/2020 |
8.1.0 | 1,204 | 8/15/2020 |
8.0.1 | 15,388 | 8/7/2020 |
8.0.0 | 8,043 | 8/7/2020 |
7.0.1 | 1,201 | 8/7/2020 |
7.0.0 | 14,078 | 6/28/2020 |
5.0.0 | 19,158 | 2/25/2020 |
4.0.4 | 19,662 | 1/27/2020 |
4.0.3 | 7,796 | 1/27/2020 |
4.0.2 | 7,864 | 1/16/2020 |
4.0.1 | 7,810 | 1/11/2020 |
4.0.0 | 7,958 | 1/5/2020 |
3.1.0 | 14,966 | 11/10/2019 |
3.0.0 | 18,006 | 10/23/2019 |
2.0.1 | 19,593 | 10/15/2019 |
2.0.0 | 8,852 | 10/13/2019 |
1.1.9 | 7,280 | 10/11/2019 |
1.1.8 | 8,801 | 10/10/2019 |
1.1.7 | 9,288 | 10/9/2019 |
1.1.6 | 4,232 | 10/7/2019 |
1.1.5 | 9,067 | 10/6/2019 |
1.1.3 | 7,455 | 10/6/2019 |
1.1.2 | 6,380 | 10/5/2019 |
1.0.1 | 5,403 | 9/26/2019 |
1.0.0 | 2,505 | 9/26/2019 |