Export (0) Print
Expand All

ChannelFactory Class

Creates and manages the channels that are used by clients to send messages to service endpoints.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public abstract class ChannelFactory : CommunicationObject, 
	IChannelFactory, ICommunicationObject, IDisposable

The ChannelFactory type exposes the following members.

  NameDescription
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsChannelFactoryInitializes a new instance of the ChannelFactory class.
Top

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsCredentialsGets the credentials used by clients to communicate a service endpoint over the channels produced by the factory.
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDefaultCloseTimeoutGets the default interval of time provided for a close operation to complete. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDefaultOpenTimeoutGets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject.DefaultOpenTimeout.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsEndpointGets the service endpoint to which the channels produced by the factory connect.
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertySupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCreateDescriptionWhen implemented in a derived class, creates a description of the service endpoint associated with the channel factory.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCreateFactoryBuilds the channel factory for the current endpoint of the factory.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibrarySupported 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.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported in .NET for Windows Store appsGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported 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.
Public methodSupported by Portable Class LibrarySupported 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.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsInitializeEndpoint(Binding, EndpointAddress)Initializes the service endpoint of the channel factory with a specified binding and address.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsInitializeEndpoint(String, EndpointAddress)Initializes the service endpoint of the channel factory with a specified address and configuration.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnAbortTerminates the inner channel factory of the current channel factory. (Overrides CommunicationObject.OnAbort().)
Protected methodSupported by Portable Class LibrarySupported 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. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodSupported by Portable Class LibrarySupported 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. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnCloseCalls close on the inner channel factory with a specified time-out for the completion of the operation. (Overrides CommunicationObject.OnClose(TimeSpan).)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnClosedInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnEndCloseCompletes an asynchronous close operation on the inner channel factory of the current channel factory. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnEndOpenCompletes an asynchronous open operation on the inner channel factory of the current channel factory. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
Protected methodSupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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. (Overrides CommunicationObject.OnOpen(TimeSpan).)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnOpenedInitializes a read-only copy of the ClientCredentials object for the channel factory. (Overrides CommunicationObject.OnOpened().)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnOpeningBuilds the inner channel factory for the current channel. (Overrides CommunicationObject.OnOpening().)
Public methodSupported by Portable Class LibrarySupported 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 by Portable Class LibrarySupported 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 by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

  NameDescription
Explicit interface implemetationPrivate methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsIDisposable.DisposeCloses the current channel factory.
Top

Channel factories that implement the IChannelFactory interface and their associated channels are generally used by the initiators of a communication pattern. Listener factories that implement the IChannelListener interface and their associated listeners provide the mechanisms with which channels are accepted for communications.

This class is not part of the channel model, but of the service model. The CreateFactory method provides the means to create an IChannelFactory for a service endpoint. Use it to construct a client that hooks up to an interface contract on the service without using metadata or policy.

NoteNote

Setting ChannelFactory.Credentials.Windows.AllowedImpersonationLevel to TokenImpersonationLevel.Anonymous always results in an anonymous logon regardless of impersonation level.

Special note for Managed C++ users deriving from this class:

  • Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • Avoid destructors; they cause the compiler to auto-generate IDisposable.

  • Avoid non-reference members; they can cause the compiler to auto-generate IDisposable.

  • Avoid using a finalizer; but if you include one, you should suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated IDisposable behavior.

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.

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.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft