https://github.com/arlodotexe/owlcore.remoting
A lightweight and ultra-flexible RPC framework for .NET Standard 2.0.
https://github.com/arlodotexe/owlcore.remoting
Last synced: 16 days ago
JSON representation
A lightweight and ultra-flexible RPC framework for .NET Standard 2.0.
- Host: GitHub
- URL: https://github.com/arlodotexe/owlcore.remoting
- Owner: Arlodotexe
- License: mit
- Created: 2022-09-06T06:14:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T03:24:41.000Z (8 months ago)
- Last Synced: 2025-04-07T14:15:09.956Z (about 1 month ago)
- Language: C#
- Size: 108 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# OwlCore.Remoting [](https://www.nuget.org/packages/OwlCore.Remoting)
A lightweight and ultra-flexible RPC framework for .NET Standard 2.0.
When a member call is intercepted, we gather the information needed to replicate the unique member change, and emit an [IRemoteMemberMessage](src/Transfer/Messages/IRemoteMemberMessage.cs), which is handled by you.
By transferring this information out and applying the instructions on another machine in the same order, you can effectively control that instance remotely.
By serializing this information and replaying it later, you can effectively record and play back all the member changes.
## Example
### See the [Docs](./docs) for more.
```csharp
using OwlCore.Remoting;
// These attribute can be applied to a specific property/method, or an entire class.
// It even works when MemberRemote is in a base class!
[RemoteProperty]
[RemoteMethod]
[RemoteOptions(RemotingDirection.ClientToHost)]
public class MyClass : IDisposable
{
private MemberRemote _memberRemote;
public MemberRemote()
{
// Pass the instance you want to remote into MemberRemote() with an ID that is identical on both machines for that instance.
// An instance will not receive member changes until you do this.
// Optionally leave out the message handler. Uses the default set by MemberRemote.SetDefaultMessageHandler(handler);
_memberRemote = new MemberRemote(this, "InstanceIdThatMatchesOnBothMachines", myMessageHandler);
}
// When the property setter is called, the value is captured and the property setter is invoked remotely.
[RemoteProperty, RemoteOptions(RemotingDirection.Bidirectional)]
public int CurrentIndex { get; set; }
// Method will be called remotely, including parameters.
[RemoteMethod, RemoteOptions(RemotingDirection.InboundHost | RemotingDirection.Outbound)]
public void SomeMethod(int data, string[] moreData)
{
// code here ...
// Execution may complete before other machines are done.
// If you need to wait for other machines to finish execution, use the _memberRemote.RemoteWaitAsync() and _memberRemote.RemoteReleaseAsync() extension methods.
}
public void Dispose()
{
// Dispose of the MemberRemote when finished. Forgetting to do this WILL result in a memory leak.
_memberRemote.Dispose();
}
}
```
## Install
Published releases are available on [NuGet](https://www.nuget.org/packages/OwlCore.Remoting). To install, run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
PM> Install-Package OwlCore.Remoting
Or using [dotnet](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet)
> dotnet add package OwlCore.Remoting
## Financing
We accept donations [here](https://github.com/sponsors/Arlodotexe) and [here](https://www.patreon.com/arlodotexe), and we do not have any active bug bounties.
## Versioning
Version numbering follows the Semantic versioning approach. However, if the major version is `0`, the code is considered alpha and breaking changes may occur as a minor update.
## License
All OwlCore code is licensed under the MIT License. OwlCore is licensed under the MIT License. See the [LICENSE](./src/LICENSE.txt) file for more details.