ICommunicationObject Interface (System.ServiceModel)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

ICommunicationObject Interface

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

Visual Basic

Public Interface ICommunicationObject

public interface ICommunicationObject

Visual C++

public interface class ICommunicationObject

type ICommunicationObject =  interface end

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 timeout.
	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:
Asynchronous versions of the open and close methods:
A set of events that provide notifications of state transitions:
A common State property for inspecting the state of an object

Version Information

.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

Platforms

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.

Reference

System.ServiceModel Namespace