IChannel Interface

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

IChannel.cs

Defines the basic interface that all channel objects must implement. It requires that they implement the state machine interface shared by all communication objects and that they implement a method to retrieve objects from the channel stack.

public interface class IChannel : System::ServiceModel::ICommunicationObject

public interface IChannel : System.ServiceModel.ICommunicationObject

type IChannel = interface
    interface ICommunicationObject

Public Interface IChannel
Implements ICommunicationObject

Derived

System.ServiceModel.Channels.ChannelBase

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>.ChannelBase<T>

System.ServiceModel.Federation.WSTrustChannel

System.ServiceModel.IClientChannel

System.ServiceModel.IContextChannel

System.ServiceModel.IDuplexContextChannel

System.ServiceModel.IServiceChannel

System.ServiceModel.Security.WSTrustChannel

Implements

ICommunicationObject

Remarks

Important

Calling methods from classes that implement this interface with untrusted data is a security risk. Call the methods from classes that implement this interface only with trusted data. For more information, see Validate All Inputs.

Channels must satisfy the contract of a state machine as defined by the ICommunicationObject interface.

The IChannel interface adds the

GetProperty method to the ICommunicationObject interface. This method provides a mechanism for retrieving properties from the channel stack regardless of where in the stack those properties live. The term "property" in the method name refers to a piece of information that belongs to one of the channels in the stack. The CLR type for that property is determined by T. This method of retrieval is also used on channel factories and channel listeners.

IChannel is inherited by each of the channel interfaces associated with the basic message-exchange patterns:

• IInputChannel for receiving messages.

• IOutputChannel for sending messages.

• IRequestChannel for sending a request.

• IReplyChannel for sending a reply.

• IDuplexChannel for bi-directional messaging.

Properties

State

Gets the current state of the communication-oriented object. (Inherited from ICommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject)
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from ICommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from ICommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject)
Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject)
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject)
GetProperty<T>()	Returns a typed object requested, if present, from the appropriate layer in the channel stack.
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject)
Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from ICommunicationObject)

Events

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