ChannelFactory<TChannel> Class

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

ChannelFactory.cs

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

generic <typename TChannel>
public ref class ChannelFactory : System::ServiceModel::ChannelFactory, System::ServiceModel::Channels::IChannelFactory<TChannel>

public class ChannelFactory<TChannel> : System.ServiceModel.ChannelFactory, System.ServiceModel.Channels.IChannelFactory<TChannel>

type ChannelFactory<'Channel> = class
    inherit ChannelFactory
    interface IChannelFactory
    interface ICommunicationObject
    interface IChannelFactory<'Channel>

Public Class ChannelFactory(Of TChannel)
Inherits ChannelFactory
Implements IChannelFactory(Of TChannel)

Type Parameters

TChannel

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

Inheritance

Object

CommunicationObject

ChannelFactory

ChannelFactory<TChannel>

Derived

System.ServiceModel.Configuration.ConfigurationChannelFactory<TChannel>

System.ServiceModel.DuplexChannelFactory<TChannel>

System.ServiceModel.Federation.WSTrustChannelFactory

System.ServiceModel.Security.WSTrustChannelFactory

System.ServiceModel.Web.WebChannelFactory<TChannel>

Implements

IChannelFactory IChannelFactory<TChannel> ICommunicationObject

Examples

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

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

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.

Constructors

ChannelFactory<TChannel>(Binding, EndpointAddress)	Initializes a new instance of the ChannelFactory<TChannel> class with a specified binding and endpoint address.
ChannelFactory<TChannel>(Binding)	Initializes a new instance of the ChannelFactory<TChannel> class.
ChannelFactory<TChannel>(ServiceEndpoint)	Initializes a new instance of the ChannelFactory<TChannel> class that produces channels with a specified endpoint.
ChannelFactory<TChannel>(Type)	Initializes a new instance of the ChannelFactory<TChannel> class.

Properties

Credentials	Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory. (Inherited from ChannelFactory)
DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactory)
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactory)
Endpoint	Gets the service endpoint to which the channels produced by the factory connect. (Inherited from ChannelFactory)
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)
ApplyConfiguration(String)	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)
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)
CreateChannel()	Creates a channel of a specified type to a specified endpoint address.
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.
CreateChannel(EndpointAddress)	Creates a channel that is used to send messages to a service at a specific endpoint address.
CreateDescription()	Creates a description of the service endpoint.
CreateFactory()	Builds the channel factory for the current endpoint of the factory. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
InitializeEndpoint(ServiceEndpoint)	Initializes the service endpoint of the channel factory with a specified endpoint. (Inherited from ChannelFactory)
InitializeEndpoint(String, EndpointAddress)	Initializes the service endpoint of the channel factory with a specified address and configuration. (Inherited from ChannelFactory)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Terminates the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
OnClose(TimeSpan)	Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
OnEndOpen(IAsyncResult)	Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory)
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. (Inherited from ChannelFactory)
OnOpened()	Initializes a read-only copy of the ClientCredentials object for the channel factory. (Inherited from ChannelFactory)
OnOpening()	Builds the inner channel factory for the current channel. (Inherited from ChannelFactory)
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()	(Inherited from ChannelFactory)
IDisposable.Dispose()	Closes the current channel factory. (Inherited from ChannelFactory)

Thread Safety

This type is thread safe.