Click here to Skip to main content
15,881,380 members
Articles / WCF
Tip/Trick

Using WCF without a generated proxy, by using ChannelFactory

Rate me:
Please Sign up or sign in to vote.
5.00/5 (8 votes)
5 Jul 2010CPOL 55.2K   24   2
I find myself re-using this sort of snippet often, so I'm posting it here for all to enjoy. :)

The issue here is: Using the built in proxy generator for referencing WCF services from client code is OK, but a neater way to do it is shown below - this ONLY works if the server and client code are both controlled by the author - its no good for publicly exposed web services where you expect the user to query the WSDL or service metadata as this will always end up with a SVCUTIL built proxy.

So what you do is, pull out your interface and your contract objects, to a 3rd assembly, and reference that from your service code and also your client. Then simply use the class shown below, from the client, plugging in the contract interface where the generic type is required. Add a config line pointing at the service endpoint. Voila!

C#
public class ServiceWrapper<T> : IDisposable where T: class
    {
        ChannelFactory<T> factory;
        private T channel;

        private readonly BasicHttpBinding binding;
        private readonly EndpointAddress endpoint;

        private readonly object lockObject = new object();
        private bool disposed;

        public ServiceWrapper(string configName)
        {
            if (ConfigurationManager.AppSettings[configName] == null)
            {
                throw new ConfigurationErrorsException(configName + " is not present in the config file");
            }

            binding = new BasicHttpBinding();
            endpoint = new EndpointAddress(ConfigurationManager.AppSettings[configName]);
            disposed = false;
        }

        public T Channel
        {
            get
            {
                if (disposed)
                {
                    throw new ObjectDisposedException("Resource ServiceWrapper<"+typeof(T)+"> has been disposed");
                }

                lock (lockObject)
                {
                    if (factory == null)
                    {
                        factory = new ChannelFactory<T>(binding, endpoint);
                        channel = factory.CreateChannel();
                    }
                }
                return channel;
            }
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }


        public void Dispose(bool disposing)
        {
            if (!disposed)
            {
                if (disposing)
                {
                    lock (lockObject)
                    {
                        if (channel != null)
                        {
                            ((IClientChannel) channel).Close();
                        }
                        if (factory != null)
                        {
                            factory.Close();
                        }
                    }

                    channel = null;
                    factory = null;
                    disposed = true;
                }
            }
        }
    }


Usage:
(Don't forget to wrap the service wrapper in a using statement so that the dispose gets called when it goes out of scope)

C#
private const string SERVICE_ENDPOINT = "ServiceEndpoint";

...

using (var sw = new ServiceWrapper<IDataService>(SERVICE_ENDPOINT))
 {
    MyType t = sw.Channel.MyFunction(3);
}


Config:

XML
<appSettings>
    <add key="ServiceEndpoint" value="http://localhost:55757/DataService.svc" />
  </appSettings>

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect
United Kingdom United Kingdom
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralReason for my vote of 5 nice one Pin
Pranay Rana30-Dec-10 17:18
professionalPranay Rana30-Dec-10 17:18 
GeneralQuick & short explanation will expose the beauty of this tip... Pin
Md. Marufuzzaman30-Jun-10 7:47
professionalMd. Marufuzzaman30-Jun-10 7:47 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.