Different forms of the WCF service contract interface

by

WCF operations can be defined using either synchronous, EAP or (as of .NET 4.5) TAP. From MSDN:

Clients can offer the developer any programming model they choose, so long as the underlying message exchange pattern is observed. So, too, can services implement operations in any manner, so long as the specified message pattern is observed.

You can actually have all 3 patterns in a single contract interface, and they would all relate to the same message.

On the wire, there’s no difference how you execute the operations. WSDL (which WCF builds from each endpoint’s ABC – address, binding and contract) doesn’t contain this information. It is generated from operation descriptions.

If you look at the OperationDescription class, which is used in a ContractDescription, you’ll see each operation has these properties: SyncMethod, BeginMethod, EndMethod and TaskMethod. When creating a description, WCF will combine all the methods according to the operation’s name into a single operation. If there’s some mismatch between operations with the same name in different patterns (e.g. different parameters) WCF would throw an exception detailing exactly what’s wrong. WCF automatically assumes (optional) “Async” suffix for Task-based methods, and Begin/End prefix for APM.

The client and server side are completely unrelated in this sense. The utility that generates proxy classes from WSDL (svcutil), can build proxies for any execution pattern. It doesn’t even have to be a WCF service.

On the server side, if more than one pattern is implemented, WCF will use just one in the following order of precedence: Task, Sync and APM. This is documented somewhere in MSDN, I just can’t find it right now. But you can look at the reference source here.

In conclusion, you can safely change your server implementation as long as you don’t modify the message the operation represents.

Regarding the scaling (should be a different question IMO)

  • WCF’s throttling default values have been updated in .NET 4.5 to much more reasonable values and are now processor-dependent (see here).
  • There’s no change in regards to the thread-pool issue. The problem stems from the initial size of the completion port thread-pool, which is initially set to 4 times the amount of the logical processors. You can use ThreadPool.SetMinThreads to increase the amount by some factor (see this post). This setting could also be beneficial on the client side.

If you use async on the server side (when calling other services, database, etc.), the threading situation could improve dramatically because you won’t be wasting thread-pool threads that are just waiting for IO to complete.

The best thing in these situations is to do a LOT of benchmarking.

More Related Contents:

  1. How and when to use ‘async’ and ‘await’
  2. If async-await doesn’t create any additional threads, then how does it make applications responsive?
  3. HttpClient.GetAsync(…) never returns when using await/async
  4. Should I avoid ‘async void’ event handlers?
  5. Running multiple async tasks and waiting for them all to complete
  6. How do yield and await implement flow of control in .NET?
  7. Fire and forget async method in asp.net mvc
  8. Task sequencing and re-entracy
  9. Calling async methods from a WCF service
  10. Enforce an async method to be called once
  11. Why use Async/await all the way down
  12. How does async works in C#?
  13. How to call wcf service Asynchronously
  14. Why use async and return await, when you can return Task directly?
  15. Executing tasks in parallel
  16. Should I worry about “This async method lacks ‘await’ operators and will run synchronously” warning
  17. Proper way to start and fire-and-forget asynchronous calls?
  18. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  19. A pattern for self-cancelling and restarting task
  20. Async always WaitingForActivation
  21. What is the correct way to cancel an async operation that doesn’t accept a CancellationToken?
  22. A pattern to pause/resume an async task?
  23. Async thread body loop, It just works, but how?
  24. Converting async/await to Task.ContinueWith
  25. Horrible performance using SqlCommand Async methods with large data
  26. How to Async Files.ReadAllLines and await for results?
  27. Async and Await with For Loop [duplicate]
  28. Await and SynchronizationContext in a managed component hosted by an unmanaged app
  29. When is the best place to use Task.Result instead of awaiting Task
  30. Timeout pattern on task-based asynchronous method in C#

Leave a Comment