IReplyChannel Interface

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines the interface that a channel must implement to be on the receiving side of a request-reply communication between messaging endpoints.

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

public interface IReplyChannel : IChannel, ICommunicationObject

NameDescription
System_CAPS_pubpropertyLocalAddress

Gets the address on which this reply channel receives messages.

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_pubmethodBeginReceiveRequest(AsyncCallback, Object)

Begins an asynchronous operation to receive an available request with a default timeout.

System_CAPS_pubmethodBeginReceiveRequest(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to receive an available request with a specified timeout.

System_CAPS_pubmethodBeginTryReceiveRequest(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to receive a request message that has a specified time out and state object associated with it.

System_CAPS_pubmethodBeginWaitForRequest(TimeSpan, AsyncCallback, Object)

Begins an asynchronous request operation that has a specified time out and state object associated with it.

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_pubmethodEndReceiveRequest(IAsyncResult)

Completes an asynchronous operation to receive an available request.

System_CAPS_pubmethodEndTryReceiveRequest(IAsyncResult, RequestContext)

Completes the specified asynchronous operation to receive a request message.

System_CAPS_pubmethodEndWaitForRequest(IAsyncResult)

Completes the specified asynchronous wait-for-a-request message operation.

System_CAPS_pubmethodGetProperty<T>()

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

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.)

System_CAPS_pubmethodReceiveRequest()

Returns the context of the request received, if one is available. If a context is not available, waits until there is one available.

System_CAPS_pubmethodReceiveRequest(TimeSpan)

Returns the context of the request received, if one is available. If a context is not available, waits until there is one available.

System_CAPS_pubmethodTryReceiveRequest(TimeSpan, RequestContext)

Returns a value that indicates whether a request is received before a specified interval of time elapses.

System_CAPS_pubmethodWaitForRequest(TimeSpan)

Returns a value that indicates whether a request message is received before a specified interval of time elapses.

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.)

The IReplyChannel interface includes synchronous and asynchronous variants of a ReceiveRequest method return an RequestContext that can be used to construct replies to received requests.

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

An IReplyChannel is not necessarily bound to a single sender. Other channels and channel interfaces provide correlation between the sender and the reply channel, but the base contract makes no such restriction.

The pull model is used with an IReplyChannel to receive messages. This model consists of calling ReceiveRequest (or one of its variants) and then waiting for a message to arrive.

.NET Framework
Available since 3.0
Return to top
Show: