Export (0) Print
Expand All

ChannelFactory<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
Assemblies:   System.ServiceModel.Primitives (in System.ServiceModel.Primitives.dll)
  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<TChannel> type exposes the following members.

  NameDescription
Public methodChannelFactory<TChannel>()Initializes a new instance of the ChannelFactory<TChannel> class.
Public methodChannelFactory<TChannel>(Binding)Initializes a new instance of the ChannelFactory<TChannel> class.
Public methodChannelFactory<TChannel>(ServiceEndpoint)Initializes a new instance of the ChannelFactory<TChannel> class that produces channels with a specified endpoint.
Public methodSupported in .NET for Windows Store appsChannelFactory<TChannel>(String)Initializes a new instance of the ChannelFactory<TChannel> class with a specified endpoint configuration name.
Protected methodSupported in .NET for Windows Store appsChannelFactory<TChannel>(Type)Initializes a new instance of the ChannelFactory<TChannel> class.
Public methodSupported in .NET for Windows Store appsChannelFactory<TChannel>(Binding, EndpointAddress)Initializes a new instance of the ChannelFactory<TChannel> class with a specified binding and endpoint address.
Public methodChannelFactory<TChannel>(Binding, String)Initializes a new instance of the ChannelFactory<TChannel> class with a specified binding and remote address.
Public methodSupported in .NET for Windows Store appsChannelFactory<TChannel>(String, EndpointAddress)Initializes a new instance of the ChannelFactory<TChannel> class associated with a specified name for the endpoint configuration and remote address.
Top

  NameDescription
Public propertySupported in .NET for Windows Store appsCredentialsGets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory.)
Protected propertySupported in .NET for Windows Store appsDefaultCloseTimeoutGets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory.)
Protected propertySupported in .NET for Windows Store appsDefaultOpenTimeoutGets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory.)
Public propertySupported in .NET for Windows Store appsEndpointGets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory.)
Protected propertySupported in .NET for Windows Store appsIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public propertySupported in .NET for Windows Store appsStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertySupported in .NET for Windows Store appsThisLockGets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodSupported in .NET for Windows Store appsAbortCauses a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported in .NET for Windows Store appsApplyConfigurationInitializes 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 methodSupported in .NET for Windows Store appsBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsClose()Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsClose(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 methodSupported in .NET for Windows Store appsCreateChannel()Creates a channel of a specified type to a specified endpoint address.
Public methodSupported in .NET for Windows Store appsCreateChannel(EndpointAddress)Creates a channel that is used to send messages to a service at a specific endpoint address.
Protected methodStatic memberCreateChannel(String)Creates a channel that is used to send messages to a service whose endpoint is configured in a specified way.
Public methodStatic memberCreateChannel(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 methodSupported in .NET for Windows Store appsCreateChannel(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 methodStatic memberCreateChannel(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.
Public methodCreateChannelWithActAsToken(SecurityToken)Creates a channel that is used to send messages to a service with an act as security token.
Public methodCreateChannelWithActAsToken(SecurityToken, EndpointAddress)Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address.
Public methodCreateChannelWithActAsToken(SecurityToken, EndpointAddress, Uri)Creates a channel that is used to send messages to a service with an act as security token at a specific endpoint address through a specified transport address.
Public methodCreateChannelWithIssuedToken(SecurityToken)Creates a channel that is used to send messages to a service with an issued security token.
Public methodCreateChannelWithIssuedToken(SecurityToken, EndpointAddress)Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address.
Public methodCreateChannelWithIssuedToken(SecurityToken, EndpointAddress, Uri)Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address through a specified transport address.
Public methodCreateChannelWithOnBehalfOfToken(SecurityToken)Creates a channel that is used to send messages to a service with an on behalf of security token.
Public methodCreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress)Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address.
Public methodCreateChannelWithOnBehalfOfToken(SecurityToken, EndpointAddress, Uri)Creates a channel that is used to send messages to a service with an on behalf of security token at a specific endpoint address through a specified transport address.
Protected methodSupported in .NET for Windows Store appsCreateDescriptionCreates a description of the service endpoint. (Overrides ChannelFactory.CreateDescription().)
Protected methodSupported in .NET for Windows Store appsCreateFactoryBuilds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory.)
Public methodSupported in .NET for Windows Store appsEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Protected methodSupported in .NET for Windows Store appsEnsureOpenedOpens the current channel factory if it is not yet opened. (Inherited from ChannelFactory.)
Public methodSupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodSupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported in .NET for Windows Store appsGetProperty<T>Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present. (Inherited from ChannelFactory.)
Public methodSupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsInitializeEndpoint(ServiceEndpoint)Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsInitializeEndpoint(Binding, EndpointAddress)Initializes the service endpoint of the channel factory with a specified binding and address. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsInitializeEndpoint(String, EndpointAddress)Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsOnAbortTerminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsOnBeginCloseBegins 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 methodSupported in .NET for Windows Store appsOnBeginOpenBegins 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 methodSupported in .NET for Windows Store appsOnCloseCalls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsOnClosedInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported in .NET for Windows Store appsOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported in .NET for Windows Store appsOnEndCloseCompletes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsOnEndOpenCompletes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsOnFaultedInserts 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 methodSupported in .NET for Windows Store appsOnOpenCalls 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 methodSupported in .NET for Windows Store appsOnOpenedInitializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory.)
Protected methodSupported in .NET for Windows Store appsOnOpeningBuilds the inner channel factory for the current channel. (Inherited from ChannelFactory.)
Public methodSupported in .NET for Windows Store appsOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsOpen(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 methodThrowIfDisposedThrows an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrImmutableThrows an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrNotOpenThrows an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public methodSupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSupported in .NET for Windows Store appsClosedOccurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public eventSupported in .NET for Windows Store appsClosingOccurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public eventSupported in .NET for Windows Store appsFaultedOccurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public eventSupported in .NET for Windows Store appsOpenedOccurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public eventSupported in .NET for Windows Store appsOpeningOccurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported in .NET for Windows Store appsIDisposable.DisposeCloses 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.5.3, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.

Show:
© 2014 Microsoft