Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ChannelFactoryBase Class

 

Provides a common base implementation for all custom channel factories.

Namespace:   System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


public abstract class ChannelFactoryBase : ChannelManagerBase, 
	IChannelFactory, ICommunicationObject

NameDescription
System_CAPS_protmethodChannelFactoryBase()

Initializes a new instance of the ChannelFactoryBase class.

System_CAPS_protmethodChannelFactoryBase(IDefaultCommunicationTimeouts)

Initializes a new instance of the ChannelFactoryBase class with specified default communication timeouts.

NameDescription
System_CAPS_protpropertyDefaultCloseTimeout

Gets the default interval of time provided for a close operation to complete.(Overrides CommunicationObject.DefaultCloseTimeout.)

System_CAPS_protpropertyDefaultOpenTimeout

Gets the default interval of time provided for an open operation to complete.(Overrides CommunicationObject.DefaultOpenTimeout.)

System_CAPS_protpropertyDefaultReceiveTimeout

Gets the default interval of time provided for a receive operation to complete.(Overrides ChannelManagerBase.DefaultReceiveTimeout.)

System_CAPS_protpropertyDefaultSendTimeout

Gets the default interval of time provided for a send operation to complete.(Overrides ChannelManagerBase.DefaultSendTimeout.)

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_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_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_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 a typed object requested, if present, from the appropriate layer in the channel stack.

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_protmethodOnAbort()

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation.(Overrides CommunicationObject.OnAbort().)

System_CAPS_protmethodOnBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close each of the channels that were created by the factory.(Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)

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

System_CAPS_protmethodOnClose(TimeSpan)

Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time.(Overrides CommunicationObject.OnClose(TimeSpan).)

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 operation to close channels that were opened by the factory.(Overrides CommunicationObject.OnEndClose(IAsyncResult).)

System_CAPS_protmethodOnEndOpen(IAsyncResult)

Completes an asynchronous operation on the open of a communication object.(Inherited from CommunicationObject.)

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)

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

System_CAPS_protmethodOnOpened()

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

System_CAPS_protmethodOnOpening()

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

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_privpropertyIDefaultCommunicationTimeouts.CloseTimeout

Gets the interval of time after which the close method, invoked by a communication object, times out.(Inherited from ChannelManagerBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDefaultCommunicationTimeouts.OpenTimeout

Gets the interval of time after which the open method, invoked by a communication object, times out.(Inherited from ChannelManagerBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDefaultCommunicationTimeouts.ReceiveTimeout

Gets the interval of time after which the receive method, invoked by a communication object, times out.(Inherited from ChannelManagerBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDefaultCommunicationTimeouts.SendTimeout

Gets the interval of time after which the send method, invoked by a communication object, times out.(Inherited from ChannelManagerBase.)

Use this base class to create a custom channel factory.

The ChannelFactoryBase class derives from the ChannelManagerBase class and implements the IChannelFactory interface for creating channels. The methods handle parameter validation and then delegate to protected, virtual or abstract methods that derived classes can override.

Each of the protected virtual methods is automatically synchronized with respect to the other methods on the IChannelFactory interface (including the state transition methods). This means that no additional locking is required to ensure that the object is in a consistent state inside the method body.

Universal Windows Platform
Available since 8
.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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2017 Microsoft