• Article

CommunicationObject Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.CommunicationObject
    System.ServiceModel.ChannelFactory
    System.ServiceModel.Channels.ChannelBase
    System.ServiceModel.Channels.ChannelManagerBase

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

Syntax

'Declaration
Public MustInherit Class CommunicationObject _
    Implements ICommunicationObject

public abstract class CommunicationObject : ICommunicationObject

The CommunicationObject type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows Phone CommunicationObject() Initializes a new instance of the CommunicationObject class.
Protected methodSupported by Silverlight for Windows Phone CommunicationObject(Object) Initializes a new instance of the CommunicationObject class with the mutually exclusive lock to protect the state transitions specified.

Top

Properties

  Name Description
Protected propertySupported by Silverlight for Windows Phone DefaultCloseTimeout When overridden in a derived class, gets the default interval of time provided for a close operation to complete.
Protected propertySupported by Silverlight for Windows Phone DefaultOpenTimeout When overridden in a derived class, gets the default interval of time provided for an open operation to complete.
Protected propertySupported by Silverlight for Windows Phone IsDisposed Gets a value that indicates whether the communication object has been disposed.
Public propertySupported by Silverlight for Windows Phone State Gets a value that indicates the current state of the communication object.
Protected propertySupported by Silverlight for Windows Phone ThisLock Gets the mutually exclusive lock that protects the class instance during a state transition.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Abort Causes a communication object to transition immediately from its current state into the closing state.
Public methodSupported by Silverlight for Windows Phone BeginClose(AsyncCallback, Object) Begins an asynchronous operation to close a communication object.
Public methodSupported by Silverlight for Windows Phone BeginClose(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object with a specified timeout.
Public methodSupported by Silverlight for Windows Phone BeginOpen(AsyncCallback, Object) Begins an asynchronous operation to close a communication object.
Public methodSupported by Silverlight for Windows Phone BeginOpen(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to close a communication object within a specified interval of time.
Public methodSupported by Silverlight for Windows Phone Close() Causes a communication object to transition from its current state into the closed state.
Public methodSupported by Silverlight for Windows Phone Close(TimeSpan) Causes a communication object to transition from its current state into the closed state within a specified interval of time.
Public methodSupported by Silverlight for Windows Phone EndClose Completes an asynchronous operation to close a communication object.
Public methodSupported by Silverlight for Windows Phone EndOpen Completes an asynchronous operation to open a communication object.
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Fault Causes a communication object to transition from its current state into the faulted state.
Protected methodSupported by Silverlight for Windows Phone Finalize Allows 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 Phone GetCommunicationObjectType Gets the type of communication object.
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone OnAbort When 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.
Protected methodSupported by Silverlight for Windows Phone OnBeginClose When 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.
Protected methodSupported by Silverlight for Windows Phone OnBeginOpen When 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.
Protected methodSupported by Silverlight for Windows Phone OnClose When 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.
Protected methodSupported by Silverlight for Windows Phone OnClosed Invoked during the transition of a communication object into the closing state.
Protected methodSupported by Silverlight for Windows Phone OnClosing Invoked during the transition of a communication object into the closing state.
Protected methodSupported by Silverlight for Windows Phone OnEndClose When implemented in a derived class, completes an asynchronous operation on the close of a communication object.
Protected methodSupported by Silverlight for Windows Phone OnEndOpen When implemented in a derived class, completes an asynchronous operation on the open of a communication object.
Protected methodSupported by Silverlight for Windows Phone OnFaulted Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.
Protected methodSupported by Silverlight for Windows Phone OnOpen When 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.
Protected methodSupported by Silverlight for Windows Phone OnOpened Invoked during the transition of a communication object into the opened state.
Protected methodSupported by Silverlight for Windows Phone OnOpening Invoked during the transition of a communication object into the opening state.
Public methodSupported by Silverlight for Windows Phone Open() Causes a communication object to transition from the created state into the opened state.
Public methodSupported by Silverlight for Windows Phone Open(TimeSpan) Causes a communication object to transition from the created state into the opened state within a specified interval of time.
Protected methodSupported by Silverlight for Windows Phone ThrowIfDisposed Throws an exception if the communication object is disposed.
Protected methodSupported by Silverlight for Windows Phone ThrowIfDisposedOrImmutable Throws an exception if the communication object the State property is not set to the Created state.
Protected methodSupported by Silverlight for Windows Phone ThrowIfDisposedOrNotOpen Throws an exception if the communication object is not in the Opened state.
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public eventSupported by Silverlight for Windows Phone Closed Occurs when a communication object transitions into the closed state.
Public eventSupported by Silverlight for Windows Phone Closing Occurs when a communication object transitions into the closing state.
Public eventSupported by Silverlight for Windows Phone Faulted Occurs when a communication object transitions into the faulted state.
Public eventSupported by Silverlight for Windows Phone Opened Occurs when a communication object transitions into the opened state.
Public eventSupported by Silverlight for Windows Phone Opening Occurs when a communication object transitions into the opening state.

Top

Remarks

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

The state machine implemented for communication-oriented objects in Silverlight 5 is the same as the state machine implemented for communication-oriented objects in Windows Communication Foundation (WCF). For a discussion of states and transitions between states, see Understanding State Changes

Version Information

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

Platforms

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

Thread Safety

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