OperationContract<\/code>, and implements them, and exposes few functions to the world to use them <\/li>\n- Windows Service To Host the WCF Service Library <\/strong>WinSvcHostedCalcService.exe<\/strong>): Host the WCF library <\/li>\n
- Console Client Application (CalcClient.exe<\/em>):<\/strong> Client Application which will use this service <\/li>\n
- Web based Client Application (CalcWebClient.exe<\/em>):<\/strong> Web Application which will use this service <\/li>\n<\/ul>\n
First Module: WCF Service Library (WCFCalcLib.dll) <\/font><\/h3>\nTo create this project, you can simply take a "Class Library" <\/strong>project, while choosing from project wizard option. let’s name it "WCFCalcLib<\/code>", it is the actual service which implements the business logic. The project already contains a file Class1.cs<\/em>, rename that file as CalcService.cs<\/em>, add one more file (ICalcService.cs<\/em>) to define the interface, although you can define interface in this file also. <\/p>\nDefinition of Service Contract <\/h4>\n [ServiceContract]\n public interface ICalcService\n {\n [OperationContract]\n double Add(double dblNum1, double dblNum2);\n [OperationContract]\n double Subtract(double dblNum1, double dblNum2);\n [OperationContract]\n double Multiply(double dblNum1, double dblNum2);\n [OperationContract]\n double Divide(double dblNum1, double dblNum2);\n } <\/strong><\/font><\/pre>\nExplanation <\/h5>\n
Interface simply defines 4 operations supported by this service. <\/p>\n
Implementation of Service Contract <\/h4>\npublic class CalcService : ICalcService\n {\n public double Add(double dblNum1, double dblNum2)\n {\n return (dblNum1 + dblNum2);\n }\n \n public double Subtract(double dblNum1, double dblNum2)\n {\n return (dblNum1 - dblNum2);\n }\n \n public double Multiply(double dblNum1, double dblNum2)\n {\n return (dblNum1 * dblNum2);\n }\n \n public double Divide(double dblNum1, double dblNum2)\n {\n return ((dblNum2 == 0) ? 0 : (dblNum1 \/ dblNum2));\n }\n } <\/strong><\/font><\/pre>\nServiceContract<\/font> Attribute <\/h5>\nService Contract describes which related operations can be tied together as a single functional unit that the client can perform on the service.<\/p>\n
OperationContract<\/font> Attribute <\/h5>\nAn Operation contract specifies that the said operation is exposed by the service, service defines the parameters and return type of an operation. <\/p>\n
As one can see, there is nothing special here, just a Service Contract definition and its implementation. <\/p>\n
Second Module: WCF Service Library (WinSvcHostedCalcService.exe)<\/font><\/h3>\nTo create this project, you can simply take a "Windows Service"<\/strong>, while choosing from project wizard option. let’s name it "WinSVCHostedCalcService<\/strong><\/code>". This module is a Windows service, which is going to host our WCF Library (business logic), providing endpoints to the outside world to use WCF library. In this module at the start of the service, an infrastructure will be created to expose the service, and when the service is stopped, all objects are disposed. <\/p>\nLittle housekeeping <\/h4>\n
Rename Service1.cs<\/em> as MyCalcWinService.cs<\/strong><\/em>.<\/font><\/p>\nAdd a member variable ServiceHost <\/code>type. As the name implies, ServiceHost <\/code>provides a host for services. Name it, for instance m_svcHost<\/strong><\/code>. <\/p>\nprivate ServiceHost m_svcHost = null ; <\/font><\/pre>\nImplement the OnStart () <\/code>and OnStop () <\/code>handler for the service. <\/pre>\nCreating end points when Service is started <\/h5>\nprotected override void OnStart(string[] args)\n {\n if (m_svcHost != null) m_svcHost.Close();\n \n string strAdrHTTP = "http:\/\/localhost:9001\/CalcService";\n string strAdrTCP = "net.tcp:\/\/localhost:9002\/CalcService";\n \n Uri[] adrbase = { new Uri(strAdrHTTP), new Uri(strAdrTCP) };\n m_svcHost = new ServiceHost(typeof(WCFCalcLib.CalcService), adrbase);\n \n ServiceMetadataBehavior mBehave = new ServiceMetadataBehavior();\n m_svcHost.Description.Behaviors.Add(mBehave);\n \n BasicHttpBinding httpb = new BasicHttpBinding();\n m_svcHost.AddServiceEndpoint(typeof(WCFCalcLib.ICalcService), httpb, strAdrHTTP);\n m_svcHost.AddServiceEndpoint(typeof(IMetadataExchange), \n MetadataExchangeBindings.CreateMexHttpBinding(), "mex");\n \n NetTcpBinding tcpb = new NetTcpBinding();\n m_svcHost.AddServiceEndpoint(typeof(WCFCalcLib.ICalcService), tcpb, strAdrTCP);\n m_svcHost.AddServiceEndpoint(typeof(IMetadataExchange), \n MetadataExchangeBindings.CreateMexTcpBinding(), "mex");\n \n m_svcHost.Open();\n } <\/strong><\/font><\/pre>\nExplanation <\/h6>\n
The OnStart() <\/code>handler is called, when the said service is started (through service control panel, or command line or otherwise), it does the following things. <\/p>\n <\/p>\n
Defines two end points. <\/p>\n
string strAdrHTTP = "http:\/\/localhost:9001\/CalcService";\nstring strAdrTCP = "net.tcp:\/\/localhost:9002\/CalcService"; <\/font><\/strong><\/pre>\nCreates and initializes a new instance of ServiceHost <\/code>class, with the instance of the service (WCFCalcLib.CalcService<\/code>) and its base addresses (adrbase<\/code>) specified. <\/p>\nUri[] adrbase = { new Uri(strAdrHTTP), new Uri(strAdrTCP) };\nm_svcHost = new ServiceHost(typeof(WCFCalcLib.CalcService), adrbase)<\/strong><\/font> <\/pre>\nAdding Service Behavior <\/h6>\n
ServiceMetadataBehavior <\/code>class controls the publication of service metadata and associated information, although. <\/p>\nServiceMetadataBehavior mBehave = new ServiceMetadataBehavior();\nm_svcHost.Description.Behaviors.Add(mBehave); <\/strong><\/font><\/pre>\nAdding service endpoints to the hosted service<\/h6>\nAdd Basic TCP end point <\/h6>\n
ServiceMetadataBehavior <\/code>class controls the publication of service metadata and associated information, although. <\/p>\nNetTcpBinding tcpb = new NetTcpBinding();\nm_svcHost.AddServiceEndpoint(typeof(WCFCalcLib.ICalcService), tcpb, strAdrTCP);<\/strong><\/font> <\/pre>\nAdd Basic HTTP end point <\/h6>\n
BasicHttpBinding httpb = new BasicHttpBinding();
\n
m_svcHost.AddServiceEndpoint(typeof(WCFCalcLib.ICalcService), httpb, strAdrHTTP);<\/strong><\/font><\/p>\nAdding just behavior to the service is not sufficient for publication of metadata, you must add an IMetadataExchange <\/code>endpoint to your service for each supported binding type. <\/strong><\/font><\/p>\nm_svcHost.AddServiceEndpoint(typeof(IMetadataExchange),
\n
MetadataExchangeBindings.CreateMexHttpBinding(), "mex");<\/p>\nm_svcHost.AddServiceEndpoint(typeof(IMetadataExchange), <\/p>\n
MetadataExchangeBindings.CreateMexTcpBinding(), "mex");<\/strong><\/font> <\/p>\n
Finally open the host, and we are ready to go. <\/p>\n
m_svcHost.Open();<\/strong><\/font> <\/p>\nDisposing, when Service is Stopped <\/h6>\n
protected override void OnStop()
\n
{<\/p>\n if (m_svcHost != null)<\/p>\n
{<\/p>\n
m_svcHost.Close();<\/p>\n
m_svcHost = null;<\/p>\n
}<\/p>\n
}<\/strong><\/font> <\/p>\n
When the service is stopped either by service console\/command prompt, or by any other means, Service host is closed, and object is assigned null<\/code>. <\/p>\nInstalling the Service <\/h6>\n
Windows service needs to be installed, and should be running, you can install the service using InstallUtil.exe<\/em> utility. This utility is part of the SDK, the path is set, when you run this utility through Visual Studio command prompt<\/strong>. <\/p>\nOpen Visual Studio Command Prompt through:<\/p>\n
Start -> All Programs -> Microsoft Visual Studio 2010 -> Visual Studio Tools -> Visual Studio Command Prompt<\/font> <\/strong><\/p>\nSwitch to the folder, where WinSvcHostedCalcService.exe<\/em> has been built, or preferably where you want to deploy it. <\/p>\nIssue the following command to Install the service:<\/p>\n
Command Prompt > InstallUtil WinSvcHostedCalcService.exe <return><\/strong><\/font><\/pre>\n![](\"http:\/\/www.codeproject.com\/KB\/WCF\/653493\/InstallService.jpg\")
<\/pre>\nStarting the Service<\/h6>\n
You can start the service using command prompt using the following command: <\/p>\n
Command Prompt > sc start WinSvcHostedCalcService <return><\/strong><\/font> <\/pre>\n![](\"http:\/\/www.codeproject.com\/KB\/WCF\/653493\/startService.jpg\")
<\/pre>\nAnother way to start the service is to: <\/p>\n
Computer -> Manage -> Services and Applications -> Services<\/strong><\/p>\nLocate<\/strong> the Service named as WinSvcHostedCalcService<\/code>, right click<\/strong> and select Start<\/strong>. <\/p>\nThird Module: Console Client Application (<\/strong>CalcClient.exe)<\/strong><\/h3>\nOnce the service has been built, and deployed, it is time to create the client. I have chosen the console based application, to keep things simple. Select the project template "Console Application", name it CalcClient<\/code>. <\/p>\nGenerating the Service Proxy <\/h6>\n
To use the service, we have to generate the proxy. Switch to the folder where client project has been created<\/strong>. Open a command prompt and issue a command to generate the proxy. <\/p>\nCommand Prompt > SvcUtil http:\/\/localhost:9001\/CalcService \/out:CalcServiceProxy.cs \/config:App.config <return><\/font><\/strong> <\/p>\n![](\"http:\/\/www.codeproject.com\/KB\/WCF\/653493\/WinClientGenerateProxy.JPG\")
<\/p>\n
Two files – a Service Proxy file and a client configuration file is generated. <\/p>\n
\n- App.config<\/strong><\/em><\/li>\n
- CalcServiceProxy.cs<\/strong><\/em><\/li>\n<\/ul>\n
Add these to files to the newly generated client project.<\/strong> When we closely examine the configuration file, we find the following sections: <\/p>\n<?xml version="1.0" encoding="utf-8"?>\n<configuration>\n <system.serviceModel>\n <bindings>\n\t\t. . . .\n <\/bindings>\n <client>\n\t\t. . . .\n <\/client>\n <\/system.serviceModel>\n<\/configuration><\/font><\/strong><\/pre>\nThe binding section holds the collection of standard and custom bindings. Each entry is a binding element that can be identified by its unique name. <\/p>\n
<bindings>\n <basicHttpBinding>\n <binding name="BasicHttpBinding_ICalcService" \/>\n <\/basicHttpBinding>\n <netTcpBinding>\n <binding name="NetTcpBinding_ICalcService" \/>\n <\/netTcpBinding>\n<\/bindings><\/strong><\/font><\/pre>\nThe client section contains a list of endpoints a client uses to connect to a service. <\/p>\n
<client>\n <endpoint<\/strong> address="http:\/\/localhost:9001\/CalcService" binding="basicHttpBinding"\n bindingConfiguration="BasicHttpBinding_ICalcService" \n contract="ICalcService" name="BasicHttpBinding_ICalcService<\/strong>" \/>\n <endpoint <\/strong>address="net.tcp:\/\/localhost:9002\/CalcService" \n binding="netTcpBinding" bindingConfiguration="NetTcpBinding_ICalcService" \n contract="ICalcService" name="NetTcpBinding_ICalcService<\/strong>">\n <identity>\n <servicePrincipalName value="host\/PRAVEEN-WIN7<\/strike>" \/>\n <\/identity>\n <\/endpoint>\n<\/client> <\/pre>\nThe client section contains a list of endpoints a client uses to connect to a service. <\/p>\n
Note<\/strong>: Identity might be different on your machine. <\/p>\nCalling the service, using the Proxy<\/p>\n
Open programs.cs<\/em> file of the client project and write code to use the service, using the generated proxy class, as shown below:<\/p>\n\n\/\/Listing of Client Program (Program.cs<\/em>): <\/p>\n<\/blockquote>\nusing System;\nusing System.Text;\nnamespace CalcClient\n{\n class Program\n {\n static void Main(string[] args)\n {\n double dblX = 2000.0;\n double dblY = 100.0;\n double dblResult = 0;\n try\n {\n Console.WriteLine("Using TCP Binding", dblX, dblY, dblResult);\n CalcServiceClient objCalcClient1 = new CalcServiceClient\n ("NetTcpBinding_ICalcService");\n dblResult = objCalcClient1.Add(dblX, dblY);\n Console.WriteLine("Calling Add >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient1.Subtract(dblX, dblY);\n Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient1.Multiply(dblX, dblY);\n Console.WriteLine("Calling Mul >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient1.Divide(dblX, dblY);\n Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n Console.WriteLine("Using Basic HTTP Binding", dblX, dblY, dblResult);\n CalcServiceClient objCalcClient2 = new CalcServiceClient\n ("BasicHttpBinding_ICalcService");\n dblResult = objCalcClient2.Add(dblX, dblY);\n Console.WriteLine("Calling Add >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient2.Subtract(dblX, dblY);\n Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient2.Multiply(dblX, dblY);\n Console.WriteLine("Calling Mul >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n dblResult = objCalcClient2.Divide(dblX, dblY);\n Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} \n Result : {2:F2}", dblX, dblY, dblResult);\n }\n catch (Exception eX)\n {\n Console.WriteLine("There was an error while calling Service \n [" + eX.Message + "]");\n }\n }\n }\n} <\/strong><\/font><\/pre>\nExplanation <\/h6>\n
It simply does two things:<\/p>\n
Creates the proxy object for the TCP binding<\/h6>\n
CalcServiceClient objCalcClient1 = new CalcServiceClient("NetTcpBinding_ICalcService"); <\/strong><\/font><\/p>\nCall the service, and print the result:<\/p>\n
dblResult = objCalcClient1.Add(dblX, dblY);
\n
Console.WriteLine("Calling Add >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient1.Subtract(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient1.Multiply(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Mul >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient1.Divide(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
<\/strong><\/font><\/p>\n
Creates the proxy object for the HTTP binding <\/p>\n
CalcServiceClient objCalcClient2 = new CalcServiceClient("BasicHttpBinding_ICalcService"); <\/strong><\/font><\/p>\nCall the service, and print the result: <\/p>\n
dblResult = objCalcClient2.Add(dblX, dblY);
\n
Console.WriteLine("Calling Add >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient2.Subtract(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient2.Multiply(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Mul >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/p>\n
dblResult = objCalcClient2.Divide(dblX, dblY);<\/p>\n
Console.WriteLine("Calling Sub >> X : {0:F2} Y : {1:F2} Result : {2:F2}", dblX, dblY, dblResult);<\/strong><\/font> <\/p>\n
Build and execute and here is the output:<\/p>\n
![](\"http:\/\/www.codeproject.com\/KB\/WCF\/653493\/ClientOutput.JPG\")
<\/p>\n
Fourth Module: Client Web page, which can use this service <\/h5>\n
Create a new Web Site, open the default page (default.aspx<\/em>), put some controls, and set the properties as described. <\/p>\n\n- asp:Label ID="Label1" Text ="Value 1 :", runat="server" <\/strong><\/font><\/li>\n
- asp:Label ID="Label2" Text ="Value 2 :", runat="server" <\/strong><\/font><\/li>\n
- asp:TextBox ID="txtVal1" runat="server" <\/strong><\/font><\/li>\n
- asp:TextBox ID="txtVal2" runat="server" <\/strong><\/font><\/li>\n
- asp:Button = ID="btnCalc", onclick="btnCalc_Click", Text="Call Service" , runat="server" <\/strong><\/font><\/li>\n<\/ul>\n
Below is the listing of default.aspx<\/em>: <\/p>\n<%@ Page Language="C#" AutoEventWireup="true"
CodeFile="Default.aspx.cs" Inherits="_Default" %><span style="<\/p>\nfont-size: 9pt;"><!DOCTYPE html PUBLIC "-\/\/W3C\/\/DTD XHTML 1.0 Transitional\/\/EN" <\/p>\n
"http:\/\/www.w3.org\/TR\/xhtml1\/DTD\/xhtml1-transitional.dtd"><\/span><pre><html <\/p>\n
xmlns="http:\/\/www.w3.org\/1999\/xhtml"><\/p>\n
<head runat="server"><\/p>\n
<title><\/title><\/p>\n
<\/head><\/p>\n
<body><\/p>\n
<form id="form1" runat="server"><\/p>\n
<div><\/p>\n
<asp:Label ID="Label1" runat="server" <\/p>\n
Text="Value 1 : "><\/asp:Label><\/p>\n
<asp:TextBox ID="txtVal1" runat="server"><\/asp:TextBox><\/p>\n
<br \/><\/p>\n
<asp:Label ID="Label2" runat="server" <\/p>\n
Text="Value 2 : "><\/asp:Label><\/p>\n
<asp:TextBox ID="txtVal2" runat="server"><\/asp:TextBox><\/p>\n
<br \/><\/p>\n
<asp:Button ID="btnCalc" runat="server" <\/p>\n
onclick="btnCalc_Click" Text="Button" <\/p>\n
Width="91px" \/><\/p>\n
<br \/><\/p>\n
<asp:Label ID="lblOutput" runat="server" <\/p>\n
BorderStyle="None" Height="152px" <\/p>\n
Width="606px"><\/asp:Label><\/p>\n
<\/div><\/p>\n
<\/form><\/p>\n
<\/body> <\/p>\n
<\/html> <\/strong><\/font><\/p>\n
Generating the Service Proxy <\/h6>\n
Right click on the website project node, select the option Add service reference. type any mex<\/strong> end point address of the service in the Address :<\/strong> field: <\/p>\nhttp:\/\/localhost:9001\/CalcService\/mex<\/font><\/strong><\/p>\nor: <\/p>\n
net.tcp:\/\/localhost:9002\/CalcService\/mex<\/font> <\/strong><\/p>\n<\/strong><\/p>\nIn the name give any name of your choice, it can be the name of the client’s namespace, let’s say for instance name it CalcServiceReference<\/strong><\/code>. <\/p>\nClick OK as shown below:<\/p>\n
![](\"http:\/\/www.codeproject.com\/KB\/WCF\/653493\/WebClientGenerateProxy.JPG\")
<\/p>\n
It will add a new App_WebReferences<\/font><\/strong><\/em> folder to your web site and will modify your web.config<\/em> file, let’s analyze the changes, it made to the web.config<\/em>. It made a new node in the last of the existing web.config<\/strong><\/font><\/em> named <system.ServiceModel><\/font><\/strong> <\/code>as shown below:<\/p>\n<system.serviceModel>
\n
<bindings><\/p>\n <basicHttpBinding><\/p>\n
<binding name="BasicHttpBinding_ICalcService"\/><\/strong><\/p>\n <\/basicHttpBinding><\/p>\n
<netTcpBinding><\/p>\n
<binding name="NetTcpBinding_ICalcService"\/><\/strong><\/p>\n <\/netTcpBinding><\/p>\n
<\/bindings><\/p>\n
<client><\/p>\n
<endpoint address<\/strong>="http:\/\/localhost:9001\/CalcService<\/strong>" <\/p>\n binding="basicHttpBinding<\/strong>" <\/p>\n bindingConfiguration="BasicHttpBinding_ICalcService<\/strong>" <\/p>\n contract="CalcServiceReference.ICalcService" <\/p>\n
name="BasicHttpBinding_ICalcService<\/strong>"\/><\/p>\n <endpoint<\/strong> address="net.tcp:\/\/localhost:9002\/CalcService"<\/strong> <\/p>\n binding="netTcpBinding<\/strong>" <\/p>\n bindingConfiguration="NetTcpBinding_ICalcService<\/strong>" <\/p>\n contract="CalcServiceReference.ICalcService" <\/p>\n
name="NetTcpBinding_ICalcService<\/strong>"><\/p>\n <identity><\/p>\n
<servicePrincipalName value="host\/PRAVEEN-WIN7<\/strike>"\/><\/p>\n
<\/identity><\/p>\n
<\/endpoint><\/p>\n
<\/client><\/p>\n
<\/font><\/system.serviceModel><\/font><\/p>\nIf you analyze it carefully, you will see two sections bindings <\/code>and client<\/code>, binding <\/code>sections simply defines the default binding names supported by this service, and client <\/code>section defines the endpoints available for this service. Each endpoint has been named, so that we know, which endpoint we are using to call the service. <\/p>\n