C# – Async WCF call with ChannelFactory and CreateChannel

async-awaitcnetwcf

I work on project where web application hosted on web server calls WCF services hosted on the app server. Proxy for WCF calls is created by ChannelFactory and calls are made via channel, example:

(omitting using block)

var factory = new ChannelFactory<IUserService>(endpointConfigurationName);
var channel = factory.CreateChannel();

var users = channel.GetAllUsers();

If I understand it well call via channel is async and thread on the web server is idle during request and just wait for a response.

I would like to make call async like this:

var users = await channel.GetAllUsersAsync();

Is there a way how to make call with ChannelFactory and channels async? I didn't find any. I know that I can generate async methods via svcutil / Add service reference but I do not want to do that. Also I don't want to change interface of service on app server (IUserService) by adding async methods.

Is there any way how to call methods async with ChannelFactory? Thanks.

Best Answer

You can automatically generate new interface that contains async versions of methods from original interface using T4 and use it in ChannelFactory without changing interface on server side.

I used NRefactory to parse original and generate new C# source code and AssemblyReferences.tt to use nuget packages in T4 template:

<#@ template debug="false" hostspecific="true" language="C#" #>
<#@ include file="AssemblyReferences.tt" #>
<#@ assembly name="System.Core" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="ICSharpCode.NRefactory.CSharp" #>
<#@ output extension=".cs"#>
<# 
var file = System.IO.File.ReadAllText(this.Host.ResolvePath("IUserService.cs")); 
if(!file.Contains("using System.Threading.Tasks;"))
{ #>
using System.Threading.Tasks;
<# } #>
<#
CSharpParser parser = new CSharpParser();
var syntaxTree = parser.Parse(file);


foreach (var namespaceDeclaration in syntaxTree.Descendants.OfType<NamespaceDeclaration>())
{
    namespaceDeclaration.Name += ".Client";
}


foreach (var methodDeclaration in syntaxTree.Descendants.OfType<MethodDeclaration>())
{
    if (methodDeclaration.Name.Contains("Async"))
        continue;

    MethodDeclaration asyncMethod = methodDeclaration.Clone() as MethodDeclaration;
    asyncMethod.Name += "Async"; 

    if (asyncMethod.ReturnType.ToString() == "void")
        asyncMethod.ReturnType = new SimpleType("Task");
    else
        asyncMethod.ReturnType = new SimpleType("Task", typeArguments: asyncMethod.ReturnType.Clone());

    methodDeclaration.Parent.AddChild(asyncMethod, Roles.TypeMemberRole);
}

#>
<#=syntaxTree.ToString()#>​

You pass your interface file name to template:

using System.Collections.Generic;
using System.ServiceModel;

namespace MyProject
{
    [ServiceContract]
    interface IUserService
    {
        [OperationContract]
        List<User> GetAllUsers();
    }
}

To get new one:

using System.Threading.Tasks;
using System.Collections.Generic;
using System.ServiceModel;

namespace MyProject.Client
{
    [ServiceContract]
    interface IUserService
    {
        [OperationContract]
        List<User> GetAllUsers ();

        [OperationContract]
        Task<List<User>> GetAllUsersAsync ();
    }
}

Now you can put it in factory to use channel asynchroniously:

var factory = new ChannelFactory<MyProject.Client.IUserService>("*");
var channel = factory.CreateChannel();
var users = await channel.GetAllUsersAsync();
Related Topic