ChannelFactoryBase Class

July 28, 2014

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

The ChannelFactoryBase type exposes the following members.

  NameDescription
Protected methodChannelFactoryBase()Initializes a new instance of the ChannelFactoryBase class.
Protected methodChannelFactoryBase(IDefaultCommunicationTimeouts)Initializes a new instance of the ChannelFactoryBase class with specified default communication timeouts.
Top

  NameDescription
Protected propertyDefaultCloseTimeoutGets the default interval of time provided for a close operation to complete. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected propertyDefaultOpenTimeoutGets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject.DefaultOpenTimeout.)
Protected propertyDefaultReceiveTimeoutGets the default interval of time provided for a receive operation to complete. (Overrides ChannelManagerBase.DefaultReceiveTimeout.)
Protected propertyDefaultSendTimeoutGets the default interval of time provided for a send operation to complete. (Overrides ChannelManagerBase.DefaultSendTimeout.)
Protected propertyIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Public propertyStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertyThisLockGets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodAbortCauses a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Public methodBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public methodBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public methodClose()Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public methodClose(TimeSpan)Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject.)
Public methodEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetProperty<T>Returns the typed object requested, if present, from the appropriate layer in the channel stack.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnAbortInserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Overrides CommunicationObject.OnAbort().)
Protected methodOnBeginCloseBegins an asynchronous operation to close each of the channels that were created by the factory. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginOpenWhen implemented in a derived class, 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.)
Protected methodOnCloseInserts 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).)
Protected methodOnClosedInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodOnEndCloseCompletes an asynchronous operation to close channels that were opened by the factory. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected methodOnEndOpenWhen implemented in a derived class, completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject.)
Protected methodOnFaultedInserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject.)
Protected methodOnOpenWhen implemented in a derived class, 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.)
Protected methodOnOpenedInvoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject.)
Protected methodOnOpeningInvoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public methodOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public methodOpen(TimeSpan)Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedThrows an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrImmutableThrows an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrNotOpenThrows an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventClosedOccurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public eventClosingOccurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public eventFaultedOccurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public eventOpenedOccurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public eventOpeningOccurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIDefaultCommunicationTimeouts.CloseTimeoutGets the interval of time after which the close method, invoked by a communication object, times out. (Inherited from ChannelManagerBase.)
Explicit interface implemetationPrivate propertyIDefaultCommunicationTimeouts.OpenTimeoutGets the interval of time after which the open method, invoked by a communication object, times out. (Inherited from ChannelManagerBase.)
Explicit interface implemetationPrivate propertyIDefaultCommunicationTimeouts.ReceiveTimeoutGets the interval of time after which the receive method, invoked by a communication object, times out. (Inherited from ChannelManagerBase.)
Explicit interface implemetationPrivate propertyIDefaultCommunicationTimeouts.SendTimeoutGets the interval of time after which the send method, invoked by a communication object, times out. (Inherited from ChannelManagerBase.)
Top

Derive from 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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft