ICommunicationObject Interface

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

Defines the contract for the basic state machine for all communication-oriented objects in the system, including channels, the channel managers, factories, listeners, and dispatchers, and service hosts.

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

Syntax

'Declaration
Public Interface ICommunicationObject

public interface ICommunicationObject

The ICommunicationObject type exposes the following members.

Properties

	Name	Description
	State	Gets the current state of the communication-oriented object.

Top

Methods

	Name	Description
	Abort	Causes a communication object to transition immediately from its current state into the closed state.
	BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object.
	BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified time-out.
	BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object.
	BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time.
	Close()	Causes a communication object to transition from its current state into the closed state.
	Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state.
	EndClose	Completes an asynchronous operation to close a communication object.
	EndOpen	Completes an asynchronous operation to open a communication object.
	Open()	Causes a communication object to transition from the created state into the opened state.
	Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time.

Top

Events

	Name	Description
	Closed	Occurs when the communication object completes its transition from the closing state into the closed state.
	Closing	Occurs when the communication object first enters the closing state.
	Faulted	Occurs when the communication object first enters the faulted state.
	Opened	Occurs when the communication object completes its transition from the opening state into the opened state.
	Opening	Occurs when the communication object first enters the opening state.

Top

Remarks

The ICommunicationObject interface defines:

• A set of open, close, and abort methods for initiating state transitions:

  • Open

  • Close

  • Abort

• Asynchronous versions of the open and close methods:

  • BeginOpen

  • EndOpen(IAsyncResult)

  • BeginClose

  • EndClose

• A set of events that provides notifications of state transitions:

  • Opening

  • Opened

  • Closing

  • Closed

  • Faulted

• A common State property for inspecting the state of an object.

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.

See Also

Reference

System.ServiceModel Namespace