IChannel Interface

 

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)

type IChannel = 
    interface
        interface ICommunicationObject
    end

NameDescription
System_CAPS_pubpropertyState

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

NameDescription
System_CAPS_pubmethodAbort()

Causes a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodBeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodClose()

Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodClose(TimeSpan)

Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodEndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodEndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.(Inherited from ICommunicationObject.)

System_CAPS_pubmethodGetProperty<'T>()

Returns a typed object requested, if present, from the appropriate layer in the channel stack.

System_CAPS_pubmethodOpen()

Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)

System_CAPS_pubmethodOpen(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.(Inherited from ICommunicationObject.)

NameDescription
System_CAPS_pubeventClosed

Occurs when the communication object completes its transition from the closing state into the closed state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventClosing

Occurs when the communication object first enters the closing state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventFaulted

Occurs when the communication object first enters the faulted state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventOpened

Occurs when the communication object completes its transition from the opening state into the opened state.(Inherited from ICommunicationObject.)

System_CAPS_pubeventOpening

Occurs when the communication object first enters the opening state.(Inherited from ICommunicationObject.)

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:

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: