ChannelFactory Class (System.ServiceModel)

Cambia visualizzazione:
ScriptFree
.NET Framework Class Library
ChannelFactory Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.ChannelFactory
      System.ServiceModel.ChannelFactory<TChannel>

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

Visual Basic

Public MustInherit Class ChannelFactory _
	Inherits CommunicationObject _
	Implements IChannelFactory, ICommunicationObject, IDisposable
C#

public abstract class ChannelFactory : CommunicationObject, 
	IChannelFactory, ICommunicationObject, IDisposable
Visual C++

public ref class ChannelFactory abstract : public CommunicationObject, 
	IChannelFactory, ICommunicationObject, IDisposable
F#

[<AbstractClass>]
type ChannelFactory =  
    class
        inherit CommunicationObject
        interface IChannelFactory
        interface ICommunicationObject
        interface IDisposable
    end

The ChannelFactory type exposes the following members.

Constructors

  Name Description
Protected method Supported by Portable Class Library ChannelFactory Initializes a new instance of the ChannelFactory class.
Top
Properties

  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.
Protected property Supported by Portable Class Library DefaultCloseTimeout Gets the default interval of time provided for a close operation to complete. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected property Supported by Portable Class Library DefaultOpenTimeout Gets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject.DefaultOpenTimeout.)
Public property Supported by Portable Class Library Endpoint Gets the service endpoint to which the channels produced by the factory connect.
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
Methods

  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.
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.)
Protected method Supported by Portable Class Library CreateDescription When implemented in a derived class, creates a description of the service endpoint associated with the channel factory.
Protected method Supported by Portable Class Library CreateFactory Builds the channel factory for the current endpoint of the factory.
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 EnsureOpened Opens the current channel factory if it is not yet opened.
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<T> Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present.
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.
Protected method Supported by Portable Class Library InitializeEndpoint(Binding, EndpointAddress) Initializes the service endpoint of the channel factory with a specified binding and address.
Protected method Supported by Portable Class Library InitializeEndpoint(String, EndpointAddress) Initializes the service endpoint of the channel factory with a specified address and configuration.
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. (Overrides CommunicationObject.OnAbort().)
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. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
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. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
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. (Overrides CommunicationObject.OnClose(TimeSpan).)
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. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected method Supported by Portable Class Library OnEndOpen Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
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. (Overrides CommunicationObject.OnOpen(TimeSpan).)
Protected method Supported by Portable Class Library OnOpened Initializes a read-only copy of the ClientCredentials object for the channel factory. (Overrides CommunicationObject.OnOpened().)
Protected method Supported by Portable Class Library OnOpening Builds the inner channel factory for the current channel. (Overrides CommunicationObject.OnOpening().)
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
Events

  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
Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method Supported by Portable Class Library IDisposable.Dispose Closes the current channel factory.
Top
Remarks

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.

Note Note

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.

Examples

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

Visual Basic

Public Class Client
  Public Shared Sub Main()
	Try
	  ' Picks up configuration from the config file.
	  Dim factory As New ChannelFactory(Of ISampleServiceChannel)("WSHttpBinding_ISampleService")

	  ' Add the client side behavior programmatically to all created channels.
	  factory.Endpoint.Behaviors.Add(New EndpointBehaviorMessageInspector())

	  Dim wcfClientChannel As ISampleServiceChannel = factory.CreateChannel()

	  ' Making calls.
	  Console.WriteLine("Enter the greeting to send: ")
            Dim greeting As String = 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 timeProblem As TimeoutException
	  Console.WriteLine("The service operation timed out. " & timeProblem.Message)
	  Console.Read()
	Catch fault As FaultException(Of SampleFault)
	  Console.WriteLine("SampleFault fault occurred: {0}", fault.Detail.FaultMessage)
	  Console.Read()
	Catch commProblem As CommunicationException
	  Console.WriteLine("There was a communication problem. " & commProblem.Message)
	  Console.Read()
	End Try
  End Sub


C#

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();
    }
  }


Version Information

.NET Framework

Supported in: 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
Platforms

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference