Export (0) Print
Expand All

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 LibraryCommunicationObject()Initializes a new instance of the CommunicationObject class.
Protected methodSupported by Portable Class LibraryCommunicationObject(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 LibraryDefaultCloseTimeoutWhen overridden in a derived class, gets the default interval of time provided for a close operation to complete.
Protected propertySupported by Portable Class LibraryDefaultOpenTimeoutWhen overridden in a derived class, gets the default interval of time provided for an open operation to complete.
Protected propertySupported by Portable Class LibraryIsDisposedGets a value that indicates whether the communication object has been disposed.
Public propertySupported by Portable Class LibraryStateGets a value that indicates the current state of the communication object.
Protected propertySupported by Portable Class LibraryThisLockGets the mutually exclusive lock that protects the class instance during a state transition.
Top

  NameDescription
Public methodSupported by Portable Class LibraryAbortCauses a communication object to transition immediately from its current state into the closing state.
Public methodSupported by Portable Class LibraryBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object.
Public methodSupported by Portable Class LibraryBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout.
Public methodSupported by Portable Class LibraryBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object.
Public methodSupported by Portable Class LibraryBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time.
Public methodSupported by Portable Class LibraryClose()Causes a communication object to transition from its current state into the closed state.
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.
Public methodSupported by Portable Class LibraryEndCloseCompletes an asynchronous operation to close a communication object.
Public methodSupported by Portable Class LibraryEndOpenCompletes an asynchronous operation to open a communication object.
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.
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.
Public methodSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
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.
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.
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.
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.
Protected methodSupported by Portable Class LibraryOnClosedInvoked during the transition of a communication object into the closing state.
Protected methodSupported by Portable Class LibraryOnClosingInvoked during the transition of a communication object into the closing state.
Protected methodSupported by Portable Class LibraryOnEndCloseCompletes an asynchronous operation on the close of a communication object.
Protected methodSupported by Portable Class LibraryOnEndOpenCompletes an asynchronous operation on the open of a communication object.
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.
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.
Protected methodSupported by Portable Class LibraryOnOpenedInvoked during the transition of a communication object into the opened state.
Protected methodSupported by Portable Class LibraryOnOpeningInvoked during the transition of a communication object into the opening state.
Public methodSupported by Portable Class LibraryOpen()Causes a communication object to transition from the created state into the opened state.
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.
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 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.
Public eventSupported by Portable Class LibraryClosingOccurs when a communication object transitions into the closing state.
Public eventSupported by Portable Class LibraryFaultedOccurs when a communication object transitions into the faulted state.
Public eventSupported by Portable Class LibraryOpenedOccurs when a communication object transitions into the opened state.
Public eventSupported by Portable Class LibraryOpeningOccurs when a communication object transitions into the opening state.
Top

The CommunicationObject class implements the ICommunicationObject interface for all communication objects in . 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, 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