ChannelFactory Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

ChannelFactory.cs

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

public ref class ChannelFactory abstract : System::ServiceModel::Channels::CommunicationObject, IAsyncDisposable, IDisposable, System::ServiceModel::Channels::IChannelFactory

public abstract class ChannelFactory : System.ServiceModel.Channels.CommunicationObject, IAsyncDisposable, IDisposable, System.ServiceModel.Channels.IChannelFactory

type ChannelFactory = class
    inherit CommunicationObject
    interface IDisposable
    interface IChannelFactory
    interface ICommunicationObject
    interface IAsyncDisposable

Public MustInherit Class ChannelFactory
Inherits CommunicationObject
Implements IAsyncDisposable, IChannelFactory, IDisposable

Inheritance

Object

CommunicationObject

ChannelFactory

Derived

System.ServiceModel.ChannelFactory<TChannel>

Implements

IDisposable IChannelFactory ICommunicationObject IAsyncDisposable

Examples

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

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

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

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.

Constructors

ChannelFactory()

Initializes a new instance of the ChannelFactory class.

Properties

Credentials	Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory.
DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete.
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete.
Endpoint	Gets the service endpoint to which the channels produced by the factory connect.
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
State	Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject)
ThisLock	Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject)
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)
CreateDescription()	When implemented in a derived class, creates a description of the service endpoint associated with the channel factory.
CreateFactory()	Builds the channel factory for the current endpoint of the factory.
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
EnsureOpened()	Opens the current channel factory if it is not yet opened.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Fault()	Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject)
GetCommunicationObjectType()	Gets the type of communication object. (Inherited from CommunicationObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>()	Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present.
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeEndpoint(Binding, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified binding and address.
InitializeEndpoint(ServiceEndpoint)	Initializes the service endpoint of the channel factory with a specified endpoint.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Terminates the inner channel factory of the current channel factory.
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous close operation on the inner channel factory of the current channel factory that has a state object associated with it.
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous open operation on the inner channel factory of the current channel factory that has a state object associated with it.
OnClose(TimeSpan)	Calls close on the inner channel factory with a specified time-out for the completion of the operation.
OnClosed()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnClosing()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnEndClose(IAsyncResult)	Completes an asynchronous close operation on the inner channel factory of the current channel factory.
OnEndOpen(IAsyncResult)	Completes an asynchronous open operation on the inner channel factory of the current channel factory.
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)
OnOpen(TimeSpan)	Calls open on the inner channel factory of the current channel factory with a specified time-out for the completion of the operation.
OnOpened()	Initializes a read-only copy of the ClientCredentials object for the channel factory.
OnOpening()	Builds the inner channel factory for the current channel.
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject)
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)
ThrowIfDisposed()	Throws an exception if the communication object is disposed. (Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()	Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()	Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

Closed	Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject)
Closing	Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject)
Faulted	Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject)
Opened	Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject)
Opening	Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject)

Explicit Interface Implementations

IAsyncDisposable.DisposeAsync()
IDisposable.Dispose()	Closes the current channel factory.

Extension Methods

ConfigureAwait(IAsyncDisposable, Boolean)

Configures how awaits on the tasks returned from an async disposable will be performed.