This topic has not yet been rated - Rate this topic

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.

  Name Description
Protected method Supported by Portable Class Library CommunicationObject() Initializes a new instance of the CommunicationObject class.
Protected method Supported by Portable Class Library CommunicationObject(Object) Initializes a new instance of the CommunicationObject class with the mutually exclusive lock to protect the state transitions specified.
Top
  Name Description
Protected property Supported by Portable Class Library DefaultCloseTimeout When overridden in a derived class, gets the default interval of time provided for a close operation to complete.
Protected property Supported by Portable Class Library DefaultOpenTimeout When overridden in a derived class, gets the default interval of time provided for an open operation to complete.
Protected property Supported by Portable Class Library IsDisposed Gets a value that indicates whether the communication object has been disposed.
Public property Supported by Portable Class Library State Gets a value that indicates the current state of the communication object.
Protected property Supported by Portable Class Library ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition.
Top
  Name Description
Public method Supported by Portable Class Library Abort Causes a communication object to transition immediately from its current state into the closing state.
Public method Supported by Portable Class Library BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object.
Public method Supported by Portable Class Library BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout.
Public method Supported by Portable Class Library BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to open a communication object.
Public method Supported by Portable Class Library BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to open a communication object within a specified interval of time.
Public method Supported by Portable Class Library Close() Causes a communication object to transition from its current state into the closed state.
Public method Supported by Portable Class Library Close(TimeSpan) Causes a communication object to transition from its current state into the closed state within a specified interval of time.
Public method Supported by Portable Class Library EndClose Completes an asynchronous operation to close a communication object.
Public method Supported by Portable Class Library EndOpen Completes an asynchronous operation to open a communication object.
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Fault Causes a communication object to transition from its current state into the faulted state.
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method Supported by Portable Class Library GetCommunicationObjectType Gets the type of communication object.
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library OnAbort Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation.
Protected method Supported by Portable Class Library OnBeginClose Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.
Protected method Supported by Portable Class Library OnBeginOpen Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation.
Protected method Supported by Portable Class Library OnClose Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.
Protected method Supported by Portable Class Library OnClosed Invoked during the transition of a communication object into the closing state.
Protected method Supported by Portable Class Library OnClosing Invoked during the transition of a communication object into the closing state.
Protected method Supported by Portable Class Library OnEndClose Completes an asynchronous operation on the close of a communication object.
Protected method Supported by Portable Class Library OnEndOpen Completes an asynchronous operation on the open of a communication object.
Protected method Supported by Portable Class Library OnFaulted Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.
Protected method Supported by Portable Class Library OnOpen Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time.
Protected method Supported by Portable Class Library OnOpened Invoked during the transition of a communication object into the opened state.
Protected method Supported by Portable Class Library OnOpening Invoked during the transition of a communication object into the opening state.
Public method Supported by Portable Class Library Open() Causes a communication object to transition from the created state into the opened state.
Public method Supported by Portable Class Library Open(TimeSpan) Causes a communication object to transition from the created state into the opened state within a specified interval of time.
Protected method ThrowIfDisposed Throws an exception if the communication object is disposed.
Protected method ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state.
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state.
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event Supported by Portable Class Library Closed Occurs when a communication object transitions into the closed state.
Public event Supported by Portable Class Library Closing Occurs when a communication object transitions into the closing state.
Public event Supported by Portable Class Library Faulted Occurs when a communication object transitions into the faulted state.
Public event Supported by Portable Class Library Opened Occurs when a communication object transitions into the opened state.
Public event Supported by Portable Class Library Opening Occurs 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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ