ChannelFactory(TChannel) Class
TOC
Collapse the table of content
Expand the table of content

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
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


type ChannelFactory<'TChannel> = 
    class
        inherit ChannelFactory
        interface IChannelFactory<'TChannel>
        interface IChannelFactory
        interface ICommunicationObject
    end

Type Parameters

TChannel

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

NameDescription
System_CAPS_pubmethodChannelFactory<'TChannel>()

Initializes a new instance of the ChannelFactory<'TChannel> class.

System_CAPS_pubmethodChannelFactory<'TChannel>(Binding)

Initializes a new instance of the ChannelFactory<'TChannel> class.

System_CAPS_pubmethodChannelFactory<'TChannel>(Binding, EndpointAddress)

Initializes a new instance of the ChannelFactory<'TChannel> class with a specified binding and endpoint address.

System_CAPS_pubmethodChannelFactory<'TChannel>(Binding, String)

Initializes a new instance of the ChannelFactory<'TChannel> class with a specified binding and remote address.

System_CAPS_pubmethodChannelFactory<'TChannel>(ServiceEndpoint)

Initializes a new instance of the ChannelFactory<'TChannel> class that produces channels with a specified endpoint.

System_CAPS_pubmethodChannelFactory<'TChannel>(String)

Initializes a new instance of the ChannelFactory<'TChannel> class with a specified endpoint configuration name.

System_CAPS_pubmethodChannelFactory<'TChannel>(String, EndpointAddress)

Initializes a new instance of the ChannelFactory<'TChannel> class associated with a specified name for the endpoint configuration and remote address.

System_CAPS_protmethodChannelFactory<'TChannel>(Type)

Initializes a new instance of the ChannelFactory<'TChannel> class.

NameDescription
System_CAPS_pubpropertyCredentials

Gets the credentials used by clients to communicate a service endpoint over the channels produced by the factory.(Inherited from ChannelFactory.)

System_CAPS_protpropertyDefaultCloseTimeout

Gets the default interval of time provided for a close operation to complete.(Inherited from ChannelFactory.)

System_CAPS_protpropertyDefaultOpenTimeout

Gets the default interval of time provided for an open operation to complete.(Inherited from ChannelFactory.)

System_CAPS_pubpropertyEndpoint

Gets the service endpoint to which the channels produced by the factory connect.(Inherited from ChannelFactory.)

System_CAPS_protpropertyIsDisposed

Gets a value that indicates whether the communication object has been disposed.(Inherited from CommunicationObject.)

System_CAPS_pubpropertyState

Gets a value that indicates the current state of the communication object.(Inherited from CommunicationObject.)

System_CAPS_protpropertyThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.(Inherited from CommunicationObject.)

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodApplyConfiguration(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.)

System_CAPS_pubmethodBeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodClose(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_pubmethodCreateChannel()

Creates a channel of a specified type to a specified endpoint address.

System_CAPS_pubmethodSystem_CAPS_staticCreateChannel(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.

System_CAPS_pubmethodSystem_CAPS_staticCreateChannel(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.

System_CAPS_pubmethodCreateChannel(EndpointAddress)

Creates a channel that is used to send messages to a service at a specific endpoint address.

System_CAPS_pubmethodCreateChannel(EndpointAddress, Uri)

Creates a channel that is used to send messages to a service at a specific endpoint address through a specified transport address.

System_CAPS_protmethodSystem_CAPS_staticCreateChannel(String)

Creates a channel that is used to send messages to a service whose endpoint is configured in a specified way.

System_CAPS_pubmethodCreateChannelWithActAsToken(SecurityToken)

Creates a channel that is used to send messages to a service with an act as security token.

System_CAPS_pubmethodCreateChannelWithActAsToken(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.

System_CAPS_pubmethodCreateChannelWithActAsToken(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.

System_CAPS_pubmethodCreateChannelWithIssuedToken(SecurityToken)

Creates a channel that is used to send messages to a service with an issued security token.

System_CAPS_pubmethodCreateChannelWithIssuedToken(SecurityToken, EndpointAddress)

Creates a channel that is used to send messages to a service with an issued security token at a specific endpoint address.

System_CAPS_pubmethodCreateChannelWithIssuedToken(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.

System_CAPS_pubmethodCreateChannelWithOnBehalfOfToken(SecurityToken)

Creates a channel that is used to send messages to a service with an on behalf of security token.

System_CAPS_pubmethodCreateChannelWithOnBehalfOfToken(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.

System_CAPS_pubmethodCreateChannelWithOnBehalfOfToken(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.

System_CAPS_protmethodCreateDescription()

Creates a description of the service endpoint.(Overrides ChannelFactory.CreateDescription().)

System_CAPS_protmethodCreateFactory()

Builds the channel factory for the current endpoint of the factory.(Inherited from ChannelFactory.)

System_CAPS_pubmethodEndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodEndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.(Inherited from CommunicationObject.)

System_CAPS_protmethodEnsureOpened()

Opens the current channel factory if it is not yet opened.(Inherited from ChannelFactory.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFault()

Causes a communication object to transition from its current state into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGetCommunicationObjectType()

Gets the type of communication object.(Inherited from CommunicationObject.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetProperty<'T>()

Returns the typed object requested, if present, from the appropriate layer in the channel stack, or null if not present.(Inherited from ChannelFactory.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInitializeEndpoint(Binding, EndpointAddress)

Initializes the service endpoint of the channel factory with a specified binding and address.(Inherited from ChannelFactory.)

System_CAPS_protmethodInitializeEndpoint(ServiceEndpoint)

Initializes the service endpoint of the channel factory with a specified endpoint.(Inherited from ChannelFactory.)

System_CAPS_protmethodInitializeEndpoint(String, EndpointAddress)

Initializes the service endpoint of the channel factory with a specified address and configuration.(Inherited from ChannelFactory.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnAbort()

Terminates the inner channel factory of the current channel factory.(Inherited from ChannelFactory.)

System_CAPS_protmethodOnBeginClose(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.)

System_CAPS_protmethodOnBeginOpen(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.)

System_CAPS_protmethodOnClose(TimeSpan)

Calls close on the inner channel factory with a specified time-out for the completion of the operation.(Inherited from ChannelFactory.)

System_CAPS_protmethodOnClosed()

Invoked during the transition of a communication object into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodOnClosing()

Invoked during the transition of a communication object into the closing state.(Inherited from CommunicationObject.)

System_CAPS_protmethodOnEndClose(IAsyncResult)

Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)

System_CAPS_protmethodOnEndOpen(IAsyncResult)

Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Inherited from ChannelFactory.)

System_CAPS_protmethodOnFaulted()

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.)

System_CAPS_protmethodOnOpen(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.)

System_CAPS_protmethodOnOpened()

Initializes a read-only copy of the ClientCredentials object for the channel factory.(Inherited from ChannelFactory.)

System_CAPS_protmethodOnOpening()

Builds the inner channel factory for the current channel.(Inherited from ChannelFactory.)

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodOpen(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposed()

Throws an exception if the communication object is disposed.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.(Inherited from CommunicationObject.)

System_CAPS_protmethodThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.(Inherited from CommunicationObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventClosed

Occurs when a communication object transitions into the closed state.(Inherited from CommunicationObject.)

System_CAPS_pubeventClosing

Occurs when a communication object transitions into the closing state.(Inherited from CommunicationObject.)

System_CAPS_pubeventFaulted

Occurs when a communication object transitions into the faulted state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpened

Occurs when a communication object transitions into the opened state.(Inherited from CommunicationObject.)

System_CAPS_pubeventOpening

Occurs when a communication object transitions into the opening state.(Inherited from CommunicationObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

Closes the current channel factory.(Inherited from ChannelFactory.)

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.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

This type is thread safe.

Return to top
Show:
© 2016 Microsoft