Export (0) Print
Expand All

IInputChannel Interface

Defines the interface that a channel must implement to receive a message.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public interface IInputChannel : IChannel, 
	ICommunicationObject

The IInputChannel type exposes the following members.

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsLocalAddressGets the address on which the input channel receives messages.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsStateGets the current state of the communication-oriented object. (Inherited from ICommunicationObject.)
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAbortCauses a communication object to transition immediately from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(AsyncCallback, Object)Begins an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginClose(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(AsyncCallback, Object)Begins an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginOpen(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginReceive(AsyncCallback, Object)Begins an asynchronous operation to receive a message that has a state object associated with it.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginReceive(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to receive a message that has a specified time out and state object associated with it.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginTryReceiveBegins an asynchronous operation to receive a message that has a specified time out and state object associated with it.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsBeginWaitForMessageBegins an asynchronous wait-for-a-message-to-arrive operation that has a specified time out and state object associated with it.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsClose()Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsClose(TimeSpan)Causes a communication object to transition from its current state into the closed state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndCloseCompletes an asynchronous operation to close a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndOpenCompletes an asynchronous operation to open a communication object. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndReceiveCompletes an asynchronous operation to receive a message.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndTryReceiveCompletes the specified asynchronous operation to receive a message.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEndWaitForMessageCompletes the specified asynchronous wait-for-a-message operation.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the channel stack. (Inherited from IChannel.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen()Causes a communication object to transition from the created state into the opened state. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpen(TimeSpan)Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from ICommunicationObject.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsReceive()Returns the message received, if one is available. If a message is not available, blocks for a default interval of time.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsReceive(TimeSpan)Returns the message received, if one is available. If a message is not available, blocks for a specified interval of time.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsTryReceiveTries to receive a message within a specified interval of time.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsWaitForMessageReturns a value that indicates whether a message has arrived within a specified interval of time.
Top

  NameDescription
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsClosedOccurs when the communication object completes its transition from the closing state into the closed state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsClosingOccurs when the communication object first enters the closing state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultedOccurs when the communication object first enters the faulted state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpenedOccurs when the communication object completes its transition from the opening state into the opened state. (Inherited from ICommunicationObject.)
Public eventSupported by Portable Class LibrarySupported in .NET for Windows Store appsOpeningOccurs when the communication object first enters the opening state. (Inherited from ICommunicationObject.)
Top

The IInputChannel contract includes synchronous and asynchronous variants of receive, try-to-receive and wait-for-a-message functionality.

The pull model is used typically with an IInputChannel to receive messages: you call Receive (to "pull" a message out of the channel) and then wait for a message to arrive. An alternative usage pattern is to call BeginWaitForMessage(TimeSpan, AsyncCallback, Object) or BeginWaitForMessage(TimeSpan, AsyncCallback, Object), and then call Receive(TimeSpan). This approach is common for transactional usages where you start the transaction between the calls to WaitForMessage(TimeSpan) and Receive.

An IInputChannel is not necessarily bound to a single sender. Other channels and channel interfaces can provide a correlation between particular senders and an IInputChannel, but the base contract makes no such restriction. An implementation can create a new IInputChannel for each message or reuse the same IInputChannel for multiple messages and senders.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft