ManiaAPI.XmlRpc 2.9.2

There is a newer version of this package available.
See the version list below for details.

dotnet add package ManiaAPI.XmlRpc --version 2.9.2

NuGet\Install-Package ManiaAPI.XmlRpc -Version 2.9.2

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="ManiaAPI.XmlRpc" Version="2.9.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ManiaAPI.XmlRpc" Version="2.9.2" />
                    

                            Directory.Packages.props

<PackageReference Include="ManiaAPI.XmlRpc" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ManiaAPI.XmlRpc --version 2.9.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ManiaAPI.XmlRpc, 2.9.2"

#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.

#:package ManiaAPI.XmlRpc@2.9.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ManiaAPI.XmlRpc&version=2.9.2
                    

                            Install as a Cake Addin

#tool nuget:?package=ManiaAPI.XmlRpc&version=2.9.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ManiaAPI.XmlRpc

Integrates the GBXRemote (XML-RPC) communication used between controllers and servers.

Both versions (GBXRemote 2 and GBXRemote 1) are supported.

This solution tries to be lightweight and compatible with as many Nadeo games as possible. For a better strongly-typed GBXRemote, use the GbxRemote.Net library.

This package is still experimental, the API can change drastically.

Usage

using ManiaAPI.XmlRpc;

await using var client = await XmlRpcClient.ConnectAsync("127.0.0.1");

object authenticationResult = await client.CallAsync("Authenticate", ["SuperAdmin", "SuperAdmin"]);

if (authenticationResult is not true)
{
    throw new Exception("Authentication failed.");
}

string gameDataDirectory = await client.CallAsync<string>("GameDataDirectory");

Console.WriteLine($"Game data directory: {gameDataDirectory}");

For callbacks:

bool enableCallbacksResult = await client.CallAsync<bool>("EnableCallbacks", true);

if (!enableCallbacksResult)
{
    throw new Exception("Failed to enable callbacks.");
}

// Subscribe to callbacks
client.Callback += async (methodName, methodParams, cancellationToken) =>
{
    Console.WriteLine($"{methodName}: {string.Join(", ", methodParams)}");
};

client.On("TrackMania.PlayerConnect", async (methodParams, cancellationToken) => 
{
    // ...
});

// Keep the connection until the server closes it
await client.WaitForCloseAsync();

Resilience

XmlRpcClient communicates over a raw TCP connection. Wrap ConnectAsync with a Polly pipeline to retry on transient connection failures:

using ManiaAPI.XmlRpc;
using Polly;
using Polly.Retry;

var pipeline = new ResiliencePipelineBuilder()
    .AddRetry(new RetryStrategyOptions
    {
        MaxRetryAttempts = 5,
        BackoffType = DelayBackoffType.Exponential
    })
    .Build();

await using var client = await pipeline.ExecuteAsync(async token =>
    await XmlRpcClient.ConnectAsync("127.0.0.1", 5000, cancellationToken: token));

Product	Compatible and additional computed target framework versions.
.NET	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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET