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 Silverlight for Windows PhoneChannelBaseInitializes a new instance of the ChannelBase class.
Top

  NameDescription
Protected propertySupported by Silverlight for Windows PhoneDefaultCloseTimeoutGets the default interval of time provided for a close operation to complete. (Overrides CommunicationObject.DefaultCloseTimeout.)
Protected propertySupported by Silverlight for Windows PhoneDefaultOpenTimeoutGets the default interval of time provided for an open operation to complete. (Overrides CommunicationObject.DefaultOpenTimeout.)
Protected propertySupported by Silverlight for Windows PhoneDefaultReceiveTimeoutGets the default interval of time provided for a receive operation to complete.
Protected propertySupported by Silverlight for Windows PhoneDefaultSendTimeoutGets the default interval of time provided for a send operation to complete.
Protected propertySupported by Silverlight for Windows PhoneIsDisposedGets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject.)
Protected propertySupported by Silverlight for Windows PhoneManagerGets the channel manager that is associated with the current channel.
Public propertySupported by Silverlight for Windows PhoneStateGets a value that indicates the current state of the communication object. (Inherited from CommunicationObject.)
Protected propertySupported by Silverlight for Windows PhoneThisLockGets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneAbortCauses a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object within a specified interval of time. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneClose()Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneClose(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 Silverlight for Windows PhoneEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFaultCauses a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneGetCommunicationObjectTypeGets the type of communication object. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetProperty<T>Returns the typed object requested, if present, from the appropriate layer in the channel stack.
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneOnAbortWhen 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.)
Protected methodSupported by Silverlight for Windows PhoneOnBeginCloseWhen 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.)
Protected methodSupported by Silverlight for Windows PhoneOnBeginOpenWhen 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 methodSupported by Silverlight for Windows PhoneOnCloseWhen 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.)
Protected methodSupported by Silverlight for Windows PhoneOnClosedInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)

In Silverlight for Windows Phone, this member is overridden by OnClosed().


In XNA Framework, this member is overridden by OnClosed().
Protected methodSupported by Silverlight for Windows PhoneOnClosingInvoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneOnEndCloseWhen implemented in a derived class, completes an asynchronous operation on the close of a communication object. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneOnEndOpenWhen implemented in a derived class, completes an asynchronous operation on the open of a communication object. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneOnFaultedInserts 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 Silverlight for Windows PhoneOnOpenWhen 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 methodSupported by Silverlight for Windows PhoneOnOpenedInvoked during the transition of a communication object into the opened state. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneOnOpeningInvoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneOpen(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 methodSupported by Silverlight for Windows PhoneThrowIfDisposedThrows an exception if the communication object is disposed. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneThrowIfDisposedOrImmutableThrows an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject.)
Protected methodSupported by Silverlight for Windows PhoneThrowIfDisposedOrNotOpenThrows an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneClosedOccurs when a communication object transitions into the closed state. (Inherited from CommunicationObject.)
Public eventSupported by Silverlight for Windows PhoneClosingOccurs when a communication object transitions into the closing state. (Inherited from CommunicationObject.)
Public eventSupported by Silverlight for Windows PhoneFaultedOccurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject.)
Public eventSupported by Silverlight for Windows PhoneOpenedOccurs when a communication object transitions into the opened state. (Inherited from CommunicationObject.)
Public eventSupported by Silverlight for Windows PhoneOpeningOccurs when a communication object transitions into the opening state. (Inherited from CommunicationObject.)
Top

  NameDescription
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIDefaultCommunicationTimeouts.CloseTimeoutGets the interval of time after which the close method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIDefaultCommunicationTimeouts.OpenTimeoutGets the interval of time after which the open method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIDefaultCommunicationTimeouts.ReceiveTimeoutGets the interval of time after which the receive method, invoked by a communication object, times out.
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIDefaultCommunicationTimeouts.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.

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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