RequestContext Class

  • Reference

Definition

Namespace:
System.ServiceModel.Channels
Assembly:
System.ServiceModel.Primitives.dll
Assembly:
System.ServiceModel.dll
Package:
System.ServiceModel.Primitives v8.0.0
Source:
RequestContext.cs
Source:
RequestContext.cs
Source:
RequestContext.cs

Provides a reply that is correlated to an incoming request.

public ref class RequestContext abstract : IDisposable
public abstract class RequestContext : IDisposable
type RequestContext = class
    interface IDisposable
Public MustInherit Class RequestContext
Implements IDisposable
Inheritance
Object
RequestContext
Implements
IDisposable

Remarks

You get a request context from an IReplyChannel. Each RequestContext encapsulates the information required to reply to the request, so that you do not have to block on the channel when waiting for each request message to receive a reply.

In the request/reply model, the RequestContext object is the link between the request that comes in and the reply that goes out. When the server receives a request, it provides a RequestContext instance that represents the request to the channel. The request context contains the original request message among other useful properties. This request context is then stashed inside the OperationContext for retrieval by your service. You typically use the Current property to access the request of the current operation.

The value of the RequestContext can be null. Because the role of the request context is to link requests to replies, it does not make sense to have a request context when you do not have a reply, and so in this case the context is set to null. For a one-way operation on top of the request/reply model, the server receives requests but does not send back a response to the client. So if the RequestContext is null unexpectedly, check first whether the operation contract is IsOneWay.

Special note for Managed C++ users deriving from this class:

  • Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.

  • Avoid destructors: they cause the compiler to auto-generate IDisposable.

  • Avoid non-reference members: they can cause the compiler to auto-generate IDisposable.

  • Avoid finalizers; but if you include one, you should suppress the build warning and call SuppressFinalize(Object) and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated IDisposable behavior.

Constructors

RequestContext()

Initializes a new instance of the RequestContext class.

Properties

RequestMessage

When overridden in a derived class, gets the message that contains the request.

Methods

Abort()

When overridden in a derived class, aborts processing the request associated with the context.
BeginReply(Message, AsyncCallback, Object)

When overridden in a derived class, begins an asynchronous operation to reply to the request associated with the current context.
BeginReply(Message, TimeSpan, AsyncCallback, Object)

When overridden in a derived class, begins an asynchronous operation to reply to the request associated with the current context within a specified interval of time.
Close()

When overridden in a derived class, closes the operation that is replying to the request context associated with the current context.
Close(TimeSpan)

When overridden in a derived class, closes the operation that is replying to the request context associated with the current context within a specified interval of time.
Dispose(Boolean)

Releases resources associated with the context.
EndReply(IAsyncResult)

When overridden in a derived class, completes an asynchronous operation to reply to a request message.
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Reply(Message, TimeSpan)

When overridden in a derived class, replies to a request message within a specified interval of time.
Reply(Message)

When overridden in a derived class, replies to a request message.
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

Releases both managed and unmanaged resources associated with the context.

Applies to