Git Product home page Git Product logo

xmlrpc's Introduction

Horizon.XmlRpc

This project targets to port Charles Cook's XML-RPC library to .NET.

Do not wonder, the original library / website is no longer available.

Installation

All libraries are available on nuget.org

Ported components

The library, respectively its main components were ported to .NET Standard. The APIs haven't changed. In addition, the library was refactored into three dedicated assemblies.

  • Horizon.XmlRpc.Core Holds all the core members and contracts required by a XML-RPC servive as well as a XML-RPC client
  • Horizon.XmlRpc.Client
    Holds the ported XmlRpcProxyGen, the IXmlRpcProxyinterface and their dependencies
  • Horizon.XmlRpc.Server
    Holds the ported XmlRpcListenerService, the documentation generator and their dependencies used to host a XML-RPC service in any .NET Standard compatible application.

Examples

This section gives you a brief introduction on how to write a service and how to consume the service with a generated client proxy.

To get a full example of a running client and server, please have a look at the Samples, based on .NET 8 BackgroundService.

First define a contrat for your service. This will be used by the client proxy and implemented from the service.

using Horizon.XmlRpc.Core;

public interface IAddService
{
    [XmlRpcMethod("Demo.addNumbers")]
    int AddNumbers(int numberA, int numberB);
}

Then define your service...

using Horizon.XmlRpc.Server;

public class AddService : XmlRpcListenerService, IAddService
{
    public int AddNumbers(int numberA, int numberB)
    {
        return numberA + numberB;
    }
}

and start a new listener.

using System.Net; 

var service = new AddService();
var listener = new HttpListener();
listener.Prefixes.Add("http://127.0.0.1:5678/");
listener.Start();

while (true)
{
    var context = listener.GetContext();
    service.ProcessRequest(context);
}

The service also provides an automatically generated documentation by browing to the opened enpoint http://127.0.0.1:5678/

To consume the service, simply create a client proxy...

using Horizon.XmlRpc.Client;

public interface IAddServiceProxy : IXmlRpcProxy, IAddService
{
}

and use the proxy to call its methods.

using Horizon.XmlRpc.Client;

var proxy = XmlRpcProxyGen.Create<IAddServiceProxy>();
proxy.Url = "http://127.0.0.1:5678";

var result = proxy.AddNumbers(3, 4);
Console.WriteLine("Received result: " + result);

// Prints 7 to the output

For more information about XML-RPC in general refer to https://xmlrpc.com

xmlrpc's People

Contributors

aberus avatar dethernal avatar horizon0156 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.