How to achieve Duplex Communication in WCF using Duplex Contract in C#

-

 Most of us are aware of how to use WCF to call server side API from client, but there is also a way to call client side API's from the Server. This is possible with the use of Duplex contract in WCF. With the help of duplex contract we will be able to achieve duplex communication. In this post we will be seeing how to accomplish this with the help of an example.

How to Define Duplex Contract in WCF?

To define the capabilities of a service we define what is called as a Service Contract which is also used for creating the proxies at the client side. While defining the Service contract there is a parameter called CallbackContract which takes in a type of Interface which is used to define the client side API's.

Service Contract for WCF

In the above example we have defined a Service Contract with a Callback Contract of type IStateChangeCallback which is an interface which exposes the API's which can be defined at the client side. In a normal WCF service we would not define the Callback contract.

Server Side Implementation

Now coming to the implementation of the Service we will refer an instance of the Callback Contract implementation which can be later used to call the client side API. Below figure demonstrates how this can be done.

WCF Service Implementation with callback contract

In the constructor of the service we are querying the OperationContext to get an instance of the call back contract instance.

Here what we are trying to do is the client will call the GetData API which will start the timer and once the timer is expired we have registered an event handler called Timer_Elapsed which uses the call back contract instance to call the client side API called OnStateChanged.

Client Side Implementation


Client side implementation of callback

Before writing the Client Side implementation as shown above we have to add the Service Reference of the WCF service by clicking on Add Service Reference.

Once its added then in the client side we have defined the class StateCallBackHandler which implements the callback contract which is generated at the client side by referring the WCF Service.

In the Main method we have created the instance of InstanceContext and passed the instance of the Callback Handler as an argument. 

Then we have to create an instance of the client passing the instance context and call the client side API GetData(). 

After executing the above code we will get the output as shown below:

Output

The first line is the data returned from the server and the second line is printed from the client side after a delay of 10 seconds as the Timer interval at the server was set to 10 seconds.

One point to note here is the binding which should be used for the Duplex Contract WCF Service, normal basichttpBinding will not support Duplex Contract.

we have to use Dual variant of the binding protocol such as "wsDualHttpBinding" to support Duplex Contract.


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