ChannelManagerBase Class
Definition
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 base implementation for managing the default timeouts that are associated with channel and listener factories.
public ref class ChannelManagerBase abstract : System::ServiceModel::Channels::CommunicationObject, System::ServiceModel::IDefaultCommunicationTimeouts
public abstract class ChannelManagerBase : System.ServiceModel.Channels.CommunicationObject, System.ServiceModel.IDefaultCommunicationTimeouts
type ChannelManagerBase = class
inherit CommunicationObject
interface IDefaultCommunicationTimeouts
Public MustInherit Class ChannelManagerBase
Inherits CommunicationObject
Implements IDefaultCommunicationTimeouts
- Inheritance
- Derived
- Implements
Remarks
Specifically, this class provides a common base implementation for the ChannelFactoryBase and ChannelListenerBase channel manager classes for managing the default timeouts that are associated with the channel factories and listeners. Channels are added to the list maintained by the manager by using one of the CreateChannel methods. Abstract properties for send and receive timeouts used by the channels and listeners that are produced are specified to coordinate the values set for the derived channel and listener factories.
The ChannelBase, which provides the base implementation for custom channels, gets its default communication timeouts for the open, close, send and receive operations from the ChannelManagerBase associated with it.
The ChannelBase also takes care of managing the manager for you. In addition to exposing a reference to the manager, the base class also notifies the manager when channels are created and destroyed. But the reference to the manager is only good until the channel is destroyed.
Constructors
ChannelManagerBase() |
Initializes a new instance of the ChannelManagerBase class. |
Properties
DefaultCloseTimeout |
When overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from CommunicationObject) |
DefaultOpenTimeout |
When overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from CommunicationObject) |
DefaultReceiveTimeout |
When overridden in a derived class, gets the default interval of time a channel has to complete the reception of a message. |
DefaultSendTimeout |
When overridden in a derived class, gets the default interval of time a channel has to complete the sending of a message. |
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) |
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) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
OnAbort() |
Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Inherited from CommunicationObject) |
OnBeginClose(TimeSpan, AsyncCallback, Object) |
Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject) |
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) |
Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. (Inherited from CommunicationObject) |
OnCloseAsync(TimeSpan) | (Inherited from CommunicationObject) |
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(IAsyncResult) |
Completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject) |
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) |
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. |
IDefaultCommunicationTimeouts.OpenTimeout |
Gets the interval of time after which the open method, invoked by a communication object, times out. |
IDefaultCommunicationTimeouts.ReceiveTimeout |
Gets the interval of time after which the receive method, invoked by a communication object, times out. |
IDefaultCommunicationTimeouts.SendTimeout |
Gets the interval of time after which the send method, invoked by a communication object, times out. |
Extension Methods
CloseHelperAsync(ICommunicationObject, TimeSpan) | |
OpenHelperAsync(ICommunicationObject, TimeSpan) | |
GetInternalCloseTimeout(CommunicationObject) |