How to Customize the API variant generated for the added WCF Service Reference

-


 We must have seen that when we try to add a WCF service reference in a client project two different versions of the API's in the service is generated. One is the Synchronous variant and the other one is the Asynchronous variant of the same method in the Service that we are referring to.

Before going to how we can customize the API generated, let us discuss about the need of Asynchronous service API. 

Why do we need to have Asynchronous API variant? 

Asynchronous Service API's allows us to do CPU intensive operation/operation which takes lots of time such as database query etc. in a separate thread so that the application's Main thread will be freed and the application will not freeze.

Choosing the type of API variant in the Client Side

We can choose to generate the API variant that we require through Service Reference Settings in the client side. For that

  • Open the Service Reference Dialog by clicking on the Reference->Add Service Reference.

Adding Service Reference


  • Once the Service Reference Dialog opens up there is a button for Advanced Settings as shown below:
Advanced settings in Service Reference


  • Click on the Advanced Button then the dialog for the advanced settings comes up where we can choose the variant of the Service APIs that we want to generate as shown below:
API generation mode


As shown in the figure there is a check box we have to check to generate Asynchronous Version of API.

Suggested Reads : Duplex Contract In WCF

Also there are two flavor's of the asynchronous API that can be generated once is the task based and the other one is the asynchronous based.

Task Based API's allows using new way of doing async operation that is using Task and async await pattern. The service method returns a Task on which we can do await.

The other flavor "generate asynchronous operation" generates API's which takes in call backs which gets triggered once the server API completes its operation.

Better is to go with the first one which is "generate task-based operation". However this will be checked by default. 

Comments

Post a Comment

Popular posts from this blog

Creating RESTful Minimal WebAPI in .Net 6 in an Easy Manner! | FastEndpoints

-
Image
  We might have developed Web APIs using MVC Controllers where we used to give Route Path Attributes to the Controller and  to identify individual methods we used to provide Actions in the Route. With the Controller approach we need to write boiler plate code in separate files which deals with the Configuration of the Web Service. Those who have worked in Node js would be aware of how easy it is to create a Web API and expose different Endpoints without the need of so much boiler plate code. Here we are going to discuss of similar approach for creating a Web API in .Net6 using FastEndpoints. Under the hood it uses Minimal API concept which tries to reduce the dependencies required to achieve a particular task. This approach is more suitable in the case of Microservice Architecture where we want to keep the dependencies to minimum. Must Read : Fluent API and Data Annotations What are FastEndpoints? FastEndpoints is a Framework compatible with .Net 6 which allows to build a...
Read more

Step By Step Guide to Detect Heap Corruption in Windows Easily

-
Image
Introduction Heap memory corruption is a critical issue that can lead to application crashes, data loss, and even security vulnerabilities. Detecting and addressing heap memory corruption early is crucial for maintaining the stability and security of Windows applications. In this blog post, we will explore how to detect heap memory corruption using two powerful tools: DebugDiag and AppVerifier. Must Read : synchronization in C++20 . Understanding Heap Memory Corruption Heap memory is a dynamically allocated memory space used by applications to store data at runtime. Heap memory corruption occurs when an application writes data beyond the allocated memory boundaries , leading to memory leaks, crashes, and unpredictable behavior. Detecting such corruption manually can be time-consuming and complex, making automated tools invaluable for identifying and diagnosing these issues. What is PageHeap? PageHeap specifically focuses on detecting heap-related problems, like heap overflows, heap und...
Read more

How to dynamically add Properties in C# .NET?

-
Image
There are certain situations where we have to create object dynamically with properties added to the object dynamically. Data related to these properties may be coming in from external sources like a file or from any other serialized format. We can achieve this with the help of reflection, but it is bit complex and should have some prior knowledge of Reflection. What is meant by Dynamic Creation of Properties in c#? Dynamic creation of properties means at the time of writing the code, programmer is not aware of the properties which can be part of the object and its value. For Example there may be some data which needs to be read from say xml file, In this case there should be some organized way by which we can represent the data, This can be in the form of a object. Content of this object and the properties cannot be deduced while writing the application, it needs to be constructed from the xml file which is read when the application runs. Expando Object Expando Object comes to the res...
Read more