IChannel Interface
Microsoft Silverlight will reach end of support after October 2021. Learn more.
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.
Namespace: System.ServiceModel.Channels
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Syntax
'Declaration
Public Interface IChannel _
Inherits ICommunicationObject
public interface IChannel : ICommunicationObject
The IChannel type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") .gif "Supported by Silverlight for Windows Phone") |
State | Gets the current state of the communication-oriented object. (Inherited from ICommunicationObject.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
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 time-out. (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 | Completes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.) |
|
EndOpen | 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.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
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.) |
Top
Remarks
Channels must satisfy the contract of a state machine as defined by the ICommunicationObject interface.
The IChannel interface adds the GetProperty<T> 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.
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.