ChannelFactory Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Creates and manages the channels that are used by clients to send messages to service endpoints.
System::Object
System.ServiceModel.Channels::CommunicationObject
System.ServiceModel::ChannelFactory
System.ServiceModel::ChannelFactory<TChannel>
System.ServiceModel.Channels::CommunicationObject
System.ServiceModel::ChannelFactory
System.ServiceModel::ChannelFactory<TChannel>
Assembly: System.ServiceModel (in System.ServiceModel.dll)
The ChannelFactory type exposes the following members.
| Name | Description | |
|---|---|---|
 | 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. (Overrides CommunicationObject::DefaultCloseTimeout.) |
| DefaultOpenTimeout | Gets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject::DefaultOpenTimeout.) |
| 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.) |
| Name | Description | |
|---|---|---|
 | Abort | Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.) |
 | 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. |
| 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 close a communication object. (Inherited from CommunicationObject.) |
| BeginOpen(TimeSpan, AsyncCallback, Object) | Begins an asynchronous operation to close 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 | Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.) |
| EndOpen | 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.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetCommunicationObjectType | Gets the type of communication object. (Inherited from CommunicationObject.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetProperty<T> | Returns the typed object requested, if present, from the appropriate layer in the channel stack, or nullptr 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(String, EndpointAddress) | Initializes the service endpoint of the channel factory with a specified address and configuration. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnAbort | Terminates the inner channel factory of the current channel factory. (Overrides CommunicationObject::OnAbort().) |
| 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).) |
| 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).) |
| OnClose | Calls close on the inner channel factory with a specified time-out for the completion of the operation. (Overrides CommunicationObject::OnClose(TimeSpan).) |
| 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 | Completes an asynchronous close operation on the inner channel factory of the current channel factory. (Overrides CommunicationObject::OnEndClose(IAsyncResult).) |
| OnEndOpen | Completes an asynchronous open operation on the inner channel factory of the current channel factory. (Overrides CommunicationObject::OnEndOpen(IAsyncResult).) |
| 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 | 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).) |
| OnOpened | Initializes a read-only copy of the ClientCredentials object for the channel factory. (Overrides CommunicationObject::OnOpened().) |
| OnOpening | Builds the inner channel factory for the current channel. (Overrides CommunicationObject::OnOpening().) |
| 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.) |
| Name | Description | |
|---|---|---|
 | 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.) |
Channel factories that implement the IChannelFactory interface and their associated channels are generally used by the initiators of a communication pattern.
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.
Capabilities
If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.
ID_CAP_NETWORKING | Windows Phone 8, Windows Phone OS 7.1 |
For more info, see App capabilities and hardware requirements for Windows Phone 8.
Show: