This documentation is archived and is not being maintained.

TransactedReceiveScope Class

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.

System.Object
  System.Activities.Activity
    System.Activities.NativeActivity
      System.ServiceModel.Activities.TransactedReceiveScope

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

[ContentPropertyAttribute("Body")]
public sealed class TransactedReceiveScope : NativeActivity

The TransactedReceiveScope type exposes the following members.

  NameDescription
Public methodTransactedReceiveScopeInitializes a new instance of the TransactedReceiveScope class.
Top

  NameDescription
Public propertyBodyGets or sets the Activity that makes up the body of the TransactedReceiveScope activity.
Protected propertyCacheIdGets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Protected propertyCanInduceIdleGets or sets a value that indicates whether the activity can cause the workflow to become idle. (Inherited from NativeActivity.)
Protected propertyConstraintsGets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public propertyDisplayNameGets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public propertyIdGets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Protected propertyImplementationThe execution logic of the activity. (Inherited from NativeActivity.)
Public propertyRequestGets or sets the Receive activity associated with this TransactedReceiveScope activity.
Public propertyVariablesGets the collection of Variables associated with this TransactedReceiveScope.
Top

  NameDescription
Protected methodAbortWhen implemented in a derived class, takes actions in response to the activity being aborted. (Inherited from NativeActivity.)
Protected methodCacheMetadata(ActivityMetadata)Not implemented. Use the CacheMetadata(NativeActivityMetadata) method instead. (Inherited from NativeActivity.)
Protected methodCacheMetadata(NativeActivityMetadata)Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Inherited from NativeActivity.)
Protected methodCancelWhen implemented in a derived class, runs logic to cause graceful early completion of the activity. (Inherited from NativeActivity.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteWhen implemented in a derived class, runs the activity’s execution logic. (Inherited from NativeActivity.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShouldSerializeDisplayNameIndicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public methodToStringReturns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)
Top

The TransactedReceiveScope activity enables you to control the lifetime of the flowed transaction.

Caution noteCaution

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 noteImportant

Whenever you use a TransactedReceiveScope it is recommended to place all Receives in the workflow within TransactedReceiveScope activities.

Important noteImportant

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.

Caution noteCaution

Do not use transacted batching endpoint behavior when a Receive activity is contained by a TransactedReceiveScope. TransactedBatchingBehavioris not supported when it is used by a Receive activity contained by a TransactedReceiveScope.

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." },
    },
};


.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: