zzczzc004/tcpservicecore

C# | TCP Service For .Net Standard (Xamarin and MVC Core)

TcpServiceCore Framework

Introduction

• Framework for building Service Oriented Applications over TCP protocol in .Net Standard environments
• WCF style (No WCF code is used)
• No SOAP, Serialization of your choice
• Enforces Asynchronous IO
• Scalable, Fast, and Lightweight

Defining the Contract

• The contract is the shared interface between the service and its clients, the set of methods that the client can call

• Start by defining contract using ServiceContract attribute on an Interface, unlike WCF you can't target classes

• Contracts can be inherit if all interfaces has ServiceContract attribute

• Define operations using OperationContract attribute, the operation is the method you want to expose to clients

• Operations must return Task or Task<T>

• One way operation (Where the client doesn't block while the service operation is executing) must return Task

• One way operation returns when the proxy writes to the network stream, delivery is not guaranteed in one way operations.

      using System;
      using System.Collections.Generic;
      using System.Linq;
      using System.Threading.Tasks;
      using TcpServiceCore.Attributes;
  
      [ServiceContract]
      public interface IService
      {
  
          [OperationContract]
          Task<string> Echo(string msg);
  
          [OperationContract(IsOneWay = true)]
          Task FireMsg(string msg);
      }
  

Creating the service

• Implement the contract and attribute the implementing class with ServiceBehavoir attribute, like WCF you can set the InstanceContextMode

• Services must define parameterless constructor

• When the InstanceContextMode is Single one service instance will be created per host

• When the InstanceContextMode is PerCall, a new isntance is created for every method call

• When the InstanceContextMode is PerSession, a new instance is created per Proxy

• Instances are not created when the proxy opens, but when the proxy issues an operation request.

    [ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]
    public class Service : IService
    {
      public Task<string> Echo(string msg)
      {
          return Task.FromResult(msg.ToUpper());
      }
  
      public Task FireMsg(string msg)
      {
          Console.WriteLine($"received {msg}");
          return Task.CompletedTask;
      }
    }
  

Serialization

• For contract parameters and return result to be marshalled, they need to be compatible with the used serializer, the framework has two built-in serializers, ProtoSerializer which is the default, and JsonSerializer.

• ProtoSerializer uses Protobuf-net nuget library, so if you use this serializer (the default) your type need to be attributed with ProtoContract and its properties need to be attributed with ProtoMember attribute

• You can implement your own serializer by implementing ISerializer interface then setting Global.Serializer static property

       Global.Serializer = new TcpServiceCore.Serialization.Json.JsonSerializer();
  

Starting the host

• Create instance of ServiceHost<T> where T is your service type
• Add contracts: for every contract you want to expose you need to call AddContract<T> on the host, where T is your contract type
• AddContract<T> takes one parameter of type ChannelConfig, so you can configure contracts differently
• Initializing Services: Sometimes you may need to initialize services before invoking their operations, you can't do that by any constructor because the dispatcher uses the parameterless constructor. So to initialize a service you can listen to ServiceInstantiated event fired by ServiceHost<T>
• Open the host

Creating Proxy

• The proxy creation is also WCF style, you create proxy using ChannelFactory<T>.CreateProxy. where T is your contract type

• ChannelFactory<T>.CreateProxy will open the connection unless you pass 'false' to the last parameter

• The generated proxy implements your contract, as well as IClientChannel interface to allow you to (Open, Close, Dispose) the proxy

    public static void Main(string[] args)
    {
        RunExample().Wait();
    }
  
    static async Task RunExample()
    {
        var config = new ChannelConfig
        {
            ReceiveTimeout = TimeSpan.FromSeconds(10),
            SendTimeout = TimeSpan.FromSeconds(10)
        };
  
        var host = new ServiceHost<Service>(9091);
  
        host.AddContract<IService>(config);
  
        host.ServiceInstantiated += s =>
        {
            //init created instances
        };
  
        await host.Open();
  
        var client = await ChannelFactory<IService>.CreateProxy("localhost", 9091, config);
  
        using ((IClientChannel)client)
        {
            var result = await client.Echo("message");
            Console.WriteLine(result);
        }
        
        Console.ReadLine();
    }
  

Example Use Cases

• Http is not mandatory and is heavy, slow, or not scalable
• Communications within datacenters
• Xamarin games
• Queuing framework
• SignalR backplane
• Metrics logging

Limitation

This framework needs the community collaboration to get it solid.