ICommunicationObject Interface

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

ICommunicationObject.cs

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.

public interface class ICommunicationObject

public interface ICommunicationObject

type ICommunicationObject = interface

Public Interface ICommunicationObject

Derived

System.ServiceModel.ChannelFactory

System.ServiceModel.ChannelFactory<TChannel>

System.ServiceModel.Channels.ChannelBase

System.ServiceModel.Channels.ChannelFactoryBase

System.ServiceModel.Channels.ChannelFactoryBase<TChannel>

System.ServiceModel.Channels.ChannelListenerBase

System.ServiceModel.Channels.ChannelListenerBase<TChannel>

System.ServiceModel.Channels.CommunicationObject

System.ServiceModel.Channels.IChannel

System.ServiceModel.Channels.IChannelFactory

System.ServiceModel.Channels.IChannelFactory<TChannel>

System.ServiceModel.Channels.IChannelListener

System.ServiceModel.Channels.IChannelListener<TChannel>

System.ServiceModel.Channels.IDuplexChannel

System.ServiceModel.Channels.IDuplexSessionChannel

System.ServiceModel.Channels.IInputChannel

System.ServiceModel.Channels.IInputSessionChannel

System.ServiceModel.Channels.IOutputChannel

System.ServiceModel.Channels.IOutputSessionChannel

System.ServiceModel.Channels.IReplyChannel

System.ServiceModel.Channels.IReplySessionChannel

System.ServiceModel.Channels.IRequestChannel

System.ServiceModel.Channels.IRequestSessionChannel

System.ServiceModel.ClientBase<TChannel>

System.ServiceModel.ClientBase<TChannel>.ChannelBase<T>

System.ServiceModel.Discovery.AnnouncementClient

System.ServiceModel.Discovery.DiscoveryClient

System.ServiceModel.Federation.WSTrustChannel

System.ServiceModel.Federation.WSTrustChannelSecurityTokenProvider

System.ServiceModel.IClientChannel

System.ServiceModel.IContextChannel

System.ServiceModel.IDuplexContextChannel

System.ServiceModel.IServiceChannel

System.ServiceModel.Security.Tokens.IssuedSecurityTokenProvider

System.ServiceModel.Security.WSTrustChannel

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 provide notifications of state transitions:

  • Opening

  • Opened

  • Closing

  • Closed

  • Faulted

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

Properties

State

Gets the current state of the communication-oriented object.

Methods

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(IAsyncResult)	Completes an asynchronous operation to close a communication object.
EndOpen(IAsyncResult)	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.

Events

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.