Export (0) Print
Expand All

ChannelBase Class

Provides the base implementation for custom channels.

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

public abstract class ChannelBase : CommunicationObject, 
	IChannel, ICommunicationObject, IDefaultCommunicationTimeouts

The ChannelBase type exposes the following members.

  NameDescription
Protected methodSupported by Portable Class LibraryChannelBaseInitializes a new instance of the ChannelBase class.
Top

  NameDescription
Protected propertySupported by Portable Class LibraryDefaultCloseTimeoutGets the default interval of time provided for a close operation to complete. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected propertySupported by Portable Class LibraryDefaultOpenTimeoutGets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject.DefaultOpenTimeout.)
Protected propertySupported by Portable Class LibraryDefaultReceiveTimeoutGets the default interval of time provided for a receive operation to complete.
Protected propertySupported by Portable Class LibraryDefaultSendTimeoutGets the default interval of time provided for a send operation to complete.
Protected propertySupported by Portable Class LibraryIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Protected propertySupported by Portable Class LibraryManagerGets the channel manager that is associated with the current channel.
Public propertySupported by Portable Class LibraryStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertySupported by Portable Class LibraryThisLockGets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodSupported by Portable Class LibraryAbortCauses a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryClose()Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryClose(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 methodSupported by Portable Class LibraryEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetProperty<T>Returns the typed object requested, if present, from the appropriate layer in the channel stack.
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryOnAbortInserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnBeginCloseInserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnBeginOpenInserts 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 methodSupported by Portable Class LibraryOnCloseInserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. (Inherited from CommunicationObject.)
Protected methodOnClosedUses diagnostic tracing during the transition into the closing state. (Overrides CommunicationObject.OnClosed().)
Protected methodSupported by Portable Class LibraryOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnEndCloseCompletes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnEndOpenCompletes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnFaultedInserts 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 methodSupported by Portable Class LibraryOnOpenInserts 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 methodSupported by Portable Class LibraryOnOpenedInvoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject.)
Protected methodSupported by Portable Class LibraryOnOpeningInvoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public methodSupported by Portable Class LibraryOpen(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 methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSupported by Portable Class LibraryClosedOccurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public eventSupported by Portable Class LibraryClosingOccurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public eventSupported by Portable Class LibraryFaultedOccurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public eventSupported by Portable Class LibraryOpenedOccurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public eventSupported by Portable Class LibraryOpeningOccurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

  NameDescription
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIDefaultCommunicationTimeouts.CloseTimeoutGets the interval of time after which the close method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIDefaultCommunicationTimeouts.OpenTimeoutGets the interval of time after which the open method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIDefaultCommunicationTimeouts.ReceiveTimeoutGets the interval of time after which the receive method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Portable Class LibraryIDefaultCommunicationTimeouts.SendTimeoutGets the interval of time after which the send method, invoked by a communication object, times out.
Top

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 null if you are creating a new transport channel at the bottom of the stack.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Community Additions

ADD
Show:
© 2014 Microsoft