ChannelBase Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Provides the base implementation for custom channels.
System::Object
System.ServiceModel.Channels::CommunicationObject
System.ServiceModel.Channels::ChannelBase
System.ServiceModel.Channels::CommunicationObject
System.ServiceModel.Channels::ChannelBase
Assembly: System.ServiceModel (in System.ServiceModel.dll)
The ChannelBase type exposes the following members.
| Name | Description | |
|---|---|---|
 | 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.) |
| DefaultReceiveTimeout | Gets the default interval of time provided for a receive operation to complete. |
| DefaultSendTimeout | Gets the default interval of time provided for a send operation to complete. |
| IsDisposed | Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.) |
| Manager | Gets the channel manager that is associated with the current channel. |
 | 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.) |
| 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.) |
| 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.) |
| 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. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnAbort | When implemented in a derived class, 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 | When implemented in a derived class, inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject.) |
| OnBeginOpen | When 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.) |
| OnClose | When implemented in a derived class, 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.) |
| OnClosed | Invoked during the transition of a communication object into the closing state. (Overrides CommunicationObject::OnClosed().) |
| OnClosing | Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.) |
| OnEndClose | When implemented in a derived class, completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject.) |
| OnEndOpen | When implemented in a derived class, 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 | When 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.) |
| 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.) |
| 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.) |
| Name | Description | |
|---|---|---|
  | 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. |
The ChannelBase class provides an abstract base class implementation of the IChannel interface. It also requires that each channel be associated with a channel manager. Note that the only constructor available for creating instances of ChannelBase requires a channelManager input parameter.
State changes are managed by inheriting from the CommunicationObject implementation of the state machine.
The ChannelBase gets its default communication timeouts for the open, close, send and receive operations from the ChannelManagerBase associated with it.
The ChannelBase also manages 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.
Even if you do use the base class, you must still provide behaviors for opening and closing the channel. The default implementations of these methods do not provide useful information.
You must also make sure to override GetProperty<T> whenever you implement a channel. GetProperty<T> is an excellent way to communicate information along the channel stack without having to know what channels are below you, or what channels above you may perform queries. Define interfaces that can be queried for available information. Whenever you do not recognize the type argument for GetProperty<T>, delegate down to the next channel in the stack or return nullptr if you are creating a new transport channel at the bottom of the stack.
Show: