Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CommunicationObject Class

Provides a common base implementation for the basic state machine common to all communication-oriented objects in the system, including channels, listeners, and the channel and listener factories.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public abstract class CommunicationObject : ICommunicationObject

The CommunicationObject type exposes the following members.

  NameDescription
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCommunicationObject()Initializes a new instance of the CommunicationObject class.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCommunicationObject(Object)Initializes a new instance of the CommunicationObject class with the mutually exclusive lock to protect the state transitions specified.
Top
  NameDescription
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDefaultCloseTimeoutWhen overridden in a derived class, gets the default interval of time provided for a close operation to complete.
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDefaultOpenTimeoutWhen overridden in a derived class, gets the default interval of time provided for an open operation to complete.
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsIsDisposedGets a value that indicates whether the communication object has been disposed.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsStateGets a value that indicates the current state of the communication object.
Protected propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsThisLockGets the mutually exclusive lock that protects the class instance during a state transition.
Top
  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAbortCauses a communication object to transition immediately from its current state into the closing state.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsClose()Causes a communication object to transition from its current state into the closed state.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsClose(TimeSpan)Causes a communication object to transition from its current state into the closed state within a specified interval of time.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndCloseCompletes an asynchronous operation to close a communication object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndOpenCompletes an asynchronous operation to open a communication object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultCauses a communication object to transition from its current state into the faulted state.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows 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 LibrarySupported in .NET for Windows Store appsGetCommunicationObjectTypeGets the type of communication object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnAbortInserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnBeginCloseInserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnBeginOpenInserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnCloseInserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnClosedInvoked during the transition of a communication object into the closing state.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnClosingInvoked during the transition of a communication object into the closing state.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnEndCloseCompletes an asynchronous operation on the close of a communication object.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnEndOpenCompletes an asynchronous operation on the open of a communication object.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnFaultedInserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnOpenInserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnOpenedInvoked during the transition of a communication object into the opened state.
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOnOpeningInvoked during the transition of a communication object into the opening state.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen()Causes a communication object to transition from the created state into the opened state.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen(TimeSpan)Causes a communication object to transition from the created state into the opened state within a specified interval of time.
Protected methodThrowIfDisposedThrows an exception if the communication object is disposed.
Protected methodThrowIfDisposedOrImmutableThrows an exception if the communication object the State property is not set to the Created state.
Protected methodThrowIfDisposedOrNotOpenThrows an exception if the communication object is not in the Opened state.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsClosedOccurs when a communication object transitions into the closed state.
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsClosingOccurs when a communication object transitions into the closing state.
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultedOccurs when a communication object transitions into the faulted state.
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpenedOccurs when a communication object transitions into the opened state.
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpeningOccurs when a communication object transitions into the opening state.
Top

The CommunicationObject class implements the ICommunicationObject interface for all communication objects in Windows Communication Foundation (WCF). The method implementations handle parameter validation, raise events that notify the occurrence of state transitions, provide the means to associated additional processing with these state transitions, and ensure that such state changes are coordinated.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft. All rights reserved.