2 out of 3 rated this helpful Rate this topic

ChannelFactory(Of TChannel) Class

A factory that creates channels of different types that are used by clients to send messages to variously configured service endpoints.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class ChannelFactory<TChannel> : ChannelFactory, 
	IChannelFactory<TChannel>, IChannelFactory, ICommunicationObject

Type Parameters

TChannel

The type of channel produced by the channel factory. This type must be either IOutputChannel or IRequestChannel.

The ChannelFactory(Of TChannel) type exposes the following members.

  Name Description
Public method ChannelFactory(Of TChannel) Initializes a new instance of the ChannelFactory(Of TChannel) class.
Public method ChannelFactory(Of TChannel)(Binding) Initializes a new instance of the ChannelFactory(Of TChannel) class.
Public method ChannelFactory(Of TChannel)(ServiceEndpoint) Initializes a new instance of the ChannelFactory(Of TChannel) class that produces channels with a specified endpoint.
Public method Supported by Portable Class Library ChannelFactory(Of TChannel)(String) Initializes a new instance of the ChannelFactory(Of TChannel) class with a specified endpoint configuration name.
Protected method ChannelFactory(Of TChannel)(Type) Initializes a new instance of the ChannelFactory(Of TChannel) class.
Public method Supported by Portable Class Library ChannelFactory(Of TChannel)(Binding, EndpointAddress) Initializes a new instance of the ChannelFactory(Of TChannel) class with a specified binding and endpoint address.
Public method ChannelFactory(Of TChannel)(Binding, String) Initializes a new instance of the ChannelFactory(Of TChannel) class with a specified binding and remote address.
Public method Supported by Portable Class Library ChannelFactory(Of TChannel)(String, EndpointAddress) Initializes a new instance of the ChannelFactory(Of TChannel) class associated with a specified name for the endpoint configuration and remote address.
Top
  Name Description
Public property Supported by Portable Class Library Credentials Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory.)
Protected property Supported by Portable Class Library DefaultCloseTimeout Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory.)
Protected property Supported by Portable Class Library DefaultOpenTimeout Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory.)
Public property Supported by Portable Class Library Endpoint Gets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory.)
Protected property Supported by Portable Class Library IsDisposed Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public property Supported by Portable Class Library State Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected property Supported by Portable Class Library ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top
  Name Description
Public method Supported by Portable Class Library Abort Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library ApplyConfiguration Initializes the channel factory with the behaviors provided by a specified configuration file and with those in the service endpoint of the channel factory. (Inherited from ChannelFactory.)
Public method Supported by Portable Class Library BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library Close Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library Close(TimeSpan) Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject.)
Public method CreateChannel Creates a channel of a specified type to a specified endpoint address.
Public method Supported by Portable Class Library CreateChannel(EndpointAddress) Creates a channel that is used to send messages to a service at a specific endpoint address.
Protected method Static member CreateChannel(String) Creates a channel that is used to send messages to a service whose endpoint is configured in a specified way.
Public method Static member CreateChannel(Binding, EndpointAddress) Creates a channel of a specified type that is used to send messages to a service endpoint that is configured with a specified binding.
Public method Supported by Portable Class Library CreateChannel(EndpointAddress, Uri) Creates a channel that is used to send messages to a service at a specific endpoint address through a specified transport address.
Public method Static member CreateChannel(Binding, EndpointAddress, Uri) Creates a channel of a specified type that is used to send messages to a service endpoint at a specified transport address that is configured with a specified binding.
Protected method Supported by Portable Class Library CreateDescription Creates a description of the service endpoint. (Overrides ChannelFactory.CreateDescription.)
Protected method Supported by Portable Class Library CreateFactory Builds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory.)
Public method Supported by Portable Class Library EndClose Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library EndOpen Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library EnsureOpened Opens the current channel factory if it is not yet opened. (Inherited from ChannelFactory.)
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Fault Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method Supported by Portable Class Library GetCommunicationObjectType Gets the type of communication object. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by Portable Class Library GetProperty(Of T) Returns the typed object requested, if present, from the appropriate layer in the channel stack, or Nothing if not present. (Inherited from ChannelFactory.)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method InitializeEndpoint(ServiceEndpoint) Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library InitializeEndpoint(Binding, EndpointAddress) Initializes the service endpoint of the channel factory with a specified binding and address. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library InitializeEndpoint(String, EndpointAddress) Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library OnAbort Terminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnBeginClose Begins an asynchronous close operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnBeginOpen Begins an asynchronous open operation on the inner channel factory of the current channel factory that has a state object associated with it. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnClose Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnClosed Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library OnClosing Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library OnEndClose Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnEndOpen Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnFaulted Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject.)
Protected method Supported by Portable Class Library OnOpen Calls open on the inner channel factory of the current channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnOpened Initializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory.)
Protected method Supported by Portable Class Library OnOpening Builds the inner channel factory for the current channel. (Inherited from ChannelFactory.)
Public method Supported by Portable Class Library Open Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library Open(TimeSpan) Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event Supported by Portable Class Library Closed Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public event Supported by Portable Class Library Closing Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public event Supported by Portable Class Library Faulted Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public event Supported by Portable Class Library Opened Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public event Supported by Portable Class Library Opening Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top
  Name Description
Explicit interface implemetation Private method Supported by Portable Class Library IDisposable.Dispose Closes the current channel factory. (Inherited from ChannelFactory.)
Top

This generic class enables more advanced scenarios where there is a requirement to create a channel factory that can be used to create more than one type of channel.

When adding behaviors programmatically, the behavior is added to the appropriate Behaviors property on the ChannelFactory prior to the creation of any channel. See the example section for a code sample.

Frequently client or calling applications (for example, middle-tier applications are client applications, too) using this type also have complex state management needs as well as performance needs. For more information about these scenarios, please see Middle-Tier Client Applications.

The following sample shows how to create a channel factory and use it to create and manage channels.


	       BasicHttpBinding binding = new BasicHttpBinding();
	       EndpointAddress address = new EndpointAddress("http://localhost:8000/ChannelApp");

	       ChannelFactory<IRequestChannel> factory =
		       new ChannelFactory<IRequestChannel>(binding, address);

	       IRequestChannel channel = factory.CreateChannel();
	       channel.Open();
	       Message request = Message.CreateMessage(MessageVersion.Soap11, "hello");
	       Message reply = channel.Request(request);
	       Console.Out.WriteLine(reply.Headers.Action);
	       reply.Close();
	       channel.Close();
	       factory.Close();


The following code example shows how to insert programmatically a client behavior prior to the creation of the channel object by the factory.


public class Client
{
  public static void Main()
  {
    try
    {
      // Picks up configuration from the config file.
      ChannelFactory<ISampleServiceChannel> factory 
        = new ChannelFactory<ISampleServiceChannel>("WSHttpBinding_ISampleService");

      // Add the client side behavior programmatically to all created channels.
      factory.Endpoint.Behaviors.Add(new EndpointBehaviorMessageInspector());

      ISampleServiceChannel wcfClientChannel = factory.CreateChannel();

      // Making calls.
      Console.WriteLine("Enter the greeting to send: ");
      string greeting = Console.ReadLine();
      Console.WriteLine("The service responded: " + wcfClientChannel.SampleMethod(greeting));

      Console.WriteLine("Press ENTER to exit:");
      Console.ReadLine();

      // Done with service. 
      wcfClientChannel.Close();
      Console.WriteLine("Done!");
    }
    catch (TimeoutException timeProblem)
    {
      Console.WriteLine("The service operation timed out. " + timeProblem.Message);
      Console.Read();
    }
    catch (FaultException<SampleFault> fault)
    {
      Console.WriteLine("SampleFault fault occurred: {0}", fault.Detail.FaultMessage);
      Console.Read();
    }
    catch (CommunicationException commProblem)
    {
      Console.WriteLine("There was a communication problem. " + commProblem.Message);
      Console.Read();
    }
  }


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

This type is thread safe.

Did you find this helpful?
(2000 characters remaining)
Community Content Add
Annotations FAQ
Channel.Open()
The first example uses channel.Open() yet the second example does not. I have seen many examples where channel.Open() is not used. Is channel.Open ever required?