TransactedReceiveScope Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An activity which scopes the lifetime of a transaction which is initiated by a received message. The transaction may be flowed into the workflow on the initiating message, or be created by the dispatcher when the message is received.
public ref class TransactedReceiveScope sealed : System::Activities::NativeActivity
[System.Windows.Markup.ContentProperty("Body")]
public sealed class TransactedReceiveScope : System.Activities.NativeActivity
[<System.Windows.Markup.ContentProperty("Body")>]
type TransactedReceiveScope = class
inherit NativeActivity
Public NotInheritable Class TransactedReceiveScope
Inherits NativeActivity
- Inheritance
- Attributes
Examples
The following example shows how to use the TransactedReceiveScope class in a Sequence activity.
return new Sequence
{
Activities =
{
new WriteLine { Text = "Service workflow begins." },
new System.ServiceModel.Activities.TransactedReceiveScope
{
Variables = { requestMessage, replyMessage },
Request = receive,
Body = new Sequence
{
Activities =
{
new WriteLine { Text = new InArgument<string>("Server side: Receive complete.") },
new WriteLine { Text = new InArgument<string>(new VisualBasicValue<string>() { ExpressionText = "\"Server side: Received = '\" + requestString.toString() + \"'\"" }) },
new PrintTransactionInfo(),
new Assign<string>
{
Value = new InArgument<string>("Server side: Sending reply."),
To = new OutArgument<string>(replyMessage)
},
new WriteLine { Text = new InArgument<string>("Server side: Begin reply.") },
new SendReply
{
Request = receive,
Content = SendContent.Create(new InArgument<string>(replyMessage)),
},
new WriteLine { Text = new InArgument<string>("Server side: Reply sent.") },
},
},
},
new WriteLine { Text = "Server workflow ends." },
},
};
Remarks
The TransactedReceiveScope activity enables you to control the lifetime of the flowed transaction.
Warning
For an initiating TransactedReceiveScope activity (a TransactedReceiveScope that contains a Receive activity with CanCreateInstance set to true
), the transaction is created before the runtime starts to execute the TransactedReceiveScope activity. This transaction is not ambient at the workflow activity layer, but it is ambient in the underlying persistence layers. If execution of the workflow encounters a Persist activity before the TransactedReceiveScope activity, the runtime tries to persist under the ambient transaction. This behavior causes a block until the transaction is completed. Because the workflow execution has not reached the Body section, the transaction cannot finish. This deadlock causes the workflow to stop responding until the transaction times out. When the transaction times out, the newly created instance is aborted.
Important
Whenever you use a TransactedReceiveScope it is recommended to place all Receives in the workflow within TransactedReceiveScope activities.
Important
When using TransactedReceiveScope and messages arrive in the incorrect order, the workflow will be aborted when trying to deliver the first out of order message. You must make sure your workflow is always at a consistent stopping point when the workflow idles. This will allow you to restart the workflow from a previous persistence point should the workflow be aborted.
Constructors
TransactedReceiveScope() |
Initializes a new instance of the TransactedReceiveScope class. |
Properties
Body |
Gets or sets the Activity that makes up the body of the TransactedReceiveScope activity. |
CacheId |
Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity) |
CanInduceIdle |
Gets or sets a value that indicates whether the activity can cause the workflow to become idle. (Inherited from NativeActivity) |
Constraints |
Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity) |
DisplayName |
Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity) |
Id |
Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity) |
Implementation |
The execution logic of the activity. (Inherited from NativeActivity) |
ImplementationVersion |
Gets or sets the implementation version of the activity. (Inherited from NativeActivity) |
Request |
Gets or sets the Receive activity associated with this TransactedReceiveScope activity. |
Variables |
Gets the collection of Variable associated with this TransactedReceiveScope. |
Methods
Abort(NativeActivityAbortContext) |
When implemented in a derived class, takes actions in response to the activity being aborted. (Inherited from NativeActivity) |
CacheMetadata(ActivityMetadata) |
Not implemented. Use the CacheMetadata(NativeActivityMetadata) method instead. (Inherited from NativeActivity) |
CacheMetadata(NativeActivityMetadata) |
Creates and validates a description of the activity's arguments, variables, child activities, and activity delegates. (Inherited from NativeActivity) |
Cancel(NativeActivityContext) |
When implemented in a derived class, runs logic to cause graceful early completion of the activity. (Inherited from NativeActivity) |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
Execute(NativeActivityContext) |
When implemented in a derived class, runs the activity's execution logic. (Inherited from NativeActivity) |
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) |
OnCreateDynamicUpdateMap(NativeActivityUpdateMapMetadata, Activity) |
Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity) |
OnCreateDynamicUpdateMap(UpdateMapMetadata, Activity) |
Raises an event when creating a map for the dynamic update. (Inherited from NativeActivity) |
ShouldSerializeDisplayName() |
Indicates whether the DisplayName property should be serialized. (Inherited from Activity) |
ToString() |
Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity) |
UpdateInstance(NativeActivityUpdateContext) |
Updates the instance of NativeActivity. (Inherited from NativeActivity) |