ChannelFactoryBase<TChannel> Class

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.Primitives.dll

Assembly:: System.ServiceModel.dll

Package:: System.ServiceModel.Primitives v6.0.0

Package:: System.ServiceModel.Primitives v6.2.0

Package:: System.ServiceModel.Primitives v8.0.0

Source:: ChannelFactoryBase.cs

Source:: ChannelFactoryBase.cs

Source:: ChannelFactoryBase.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a common base implementation for channel factories on the client to create channels of a specified type connected to a specified address.

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

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

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

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

Public MustInherit Class ChannelFactoryBase(Of TChannel)
Inherits ChannelFactoryBase
Implements IChannelFactory(Of TChannel)

Type Parameters

TChannel

The type of channel the factory produces.

Inheritance: Object

CommunicationObject

ChannelManagerBase

ChannelFactoryBase
ChannelFactoryBase<TChannel>

Derived: System.ServiceModel.Channels.NetFramingTransportChannelFactory<TChannel>

Implements: IChannelFactory IChannelFactory<TChannel> ICommunicationObject

Remarks

The channels created by channel factories on the client are accepted on the server by channel listeners. Once the channel connection is established between client and service, they can communicate by exchanging messages.

The CreateChannel uses the specified address as the destination for outgoing messages. The ServiceAddress.Uri property is used as the To header in the message. The ServiceReference.Via property is used as the physical destination to send messages to. This is typically the same as the ServiceAddress.Uri value.

Constructors

ChannelFactoryBase<TChannel>()	Initializes a new instance of the ChannelFactoryBase<TChannel> class.
ChannelFactoryBase<TChannel>(IDefaultCommunicationTimeouts)	Initializes a new instance of the ChannelFactoryBase<TChannel> class with the default communication timeouts specified.

Properties

DefaultCloseTimeout	Gets the default interval of time provided for a close operation to complete. (Inherited from ChannelFactoryBase)
DefaultOpenTimeout	Gets the default interval of time provided for an open operation to complete. (Inherited from ChannelFactoryBase)
DefaultReceiveTimeout	Gets the default interval of time provided for a receive operation to complete. (Inherited from ChannelFactoryBase)
DefaultSendTimeout	Gets the default interval of time provided for a send operation to complete. (Inherited from ChannelFactoryBase)
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)
CreateChannel(EndpointAddress)	Creates a particular type of channel with a specified endpoint address.
CreateChannel(EndpointAddress, Uri)	Creates a particular type of channel with specified transport and endpoint addresses.
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)
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 a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from ChannelFactoryBase)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Aborts each channel managed by the channel factory.
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close all the channels associated with the channel factory within a specified interval of time.
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation. (Inherited from CommunicationObject)
OnClose(TimeSpan)	Closes all the channels associated with the channel factory within a specified interval of time.
OnCloseAsync(TimeSpan)
OnCloseAsync(TimeSpan)	(Inherited from ChannelFactoryBase)
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)
OnCreateChannel(EndpointAddress, Uri)	When implemented in a derived class, provides an extensibility point when creating channels.
OnEndClose(IAsyncResult)	Completes an asynchronous operation to close all the channels associated with the channel factory within a specified interval of time.
OnEndOpen(IAsyncResult)	Completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject)
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)	Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time. (Inherited from CommunicationObject)
OnOpenAsync(TimeSpan)	(Inherited from CommunicationObject)
OnOpened()	Invoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject)
OnOpening()	Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject)
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)
ValidateCreateChannel()	Confirms that the channel factory is opened and ready to create channels.

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

IAsyncCommunicationObject.CloseAsync(TimeSpan)	(Inherited from CommunicationObject)
IAsyncCommunicationObject.OpenAsync(TimeSpan)	(Inherited from CommunicationObject)
IDefaultCommunicationTimeouts.CloseTimeout	Gets the interval of time after which the close method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.OpenTimeout	Gets the interval of time after which the open method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.ReceiveTimeout	Gets the interval of time after which the receive method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)
IDefaultCommunicationTimeouts.SendTimeout	Gets the interval of time after which the send method, invoked by a communication object, times out. (Inherited from ChannelManagerBase)

Extension Methods

CloseHelperAsync(ICommunicationObject, TimeSpan)
OpenHelperAsync(ICommunicationObject, TimeSpan)
GetInternalCloseTimeout(CommunicationObject)

Applies to