LockingPersistenceProvider Class

Definition

Caution

The WF3 types are deprecated. Instead, please use the new WF4 types from System.Activities.*

The abstract base class from which all durable service persistence providers that implement locking are derived.

public ref class LockingPersistenceProvider abstract : System::ServiceModel::Persistence::PersistenceProvider
public abstract class LockingPersistenceProvider : System.ServiceModel.Persistence.PersistenceProvider
[System.Obsolete("The WF3 types are deprecated.  Instead, please use the new WF4 types from System.Activities.*")]
public abstract class LockingPersistenceProvider : System.ServiceModel.Persistence.PersistenceProvider
type LockingPersistenceProvider = class
    inherit PersistenceProvider
[<System.Obsolete("The WF3 types are deprecated.  Instead, please use the new WF4 types from System.Activities.*")>]
type LockingPersistenceProvider = class
    inherit PersistenceProvider
Public MustInherit Class LockingPersistenceProvider
Inherits PersistenceProvider
Inheritance
LockingPersistenceProvider
Attributes

Remarks

In addition to persistence, the LockingPersistenceProvider class implements locking of service state data records. Methods that interact with persisted data (such as the Load method) have an optional parameter (lockInstance) that defines whether locks on the data in question are released or maintained.

Constructors

LockingPersistenceProvider(Guid)

When implemented in a derived class, creates a new instance of the LockingPersistenceProvider class, configured with the specified identity value.

Properties

DefaultCloseTimeout

When overridden in a derived class, gets the default interval of time provided for a close operation to complete.

(Inherited from CommunicationObject)
DefaultOpenTimeout

When overridden in a derived class, gets the default interval of time provided for an open operation to complete.

(Inherited from CommunicationObject)
Id

Represents the Guid associated with this instance.

(Inherited from PersistenceProvider)
IsDisposed

Gets a value that indicates whether the communication object has been disposed.

(Inherited from CommunicationObject)
State

Gets a value that indicates the current state of the communication object.

(Inherited from CommunicationObject)
ThisLock

Gets the mutually exclusive lock that protects the class instance during a state transition.

(Inherited from CommunicationObject)

Methods

Abort()

Causes a communication object to transition immediately from its current state into the closing state.

(Inherited from CommunicationObject)
BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

(Inherited from CommunicationObject)
BeginCreate(Object, TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to create instance state information in the persistence store using the parameters. This method does not unlock the instance after saving the state information.

BeginCreate(Object, TimeSpan, Boolean, AsyncCallback, Object)

Begins an asynchronous operation to create instance state information in the persistence store using the parameters. This method unlocks the instance after saving the instance state if the value of the unlockInstance parameter is true.

BeginDelete(Object, TimeSpan, AsyncCallback, Object)

When implemented in a derived class, represents the beginning of the Delete phase. The Delete phase occurs when service state data is permanently deleted from the persistence store.

(Inherited from PersistenceProvider)
BeginLoad(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to load an instance based on state information in the persistence store using the parameters. This method does not lock the instance.

BeginLoad(TimeSpan, Boolean, AsyncCallback, Object)

Begins an asynchronous operation to load an instance based on state information in the persistence store using the parameters. This method locks the instance after loading the instance state if the value of the lockInstance parameter is true.

BeginLoadIfChanged(TimeSpan, Object, AsyncCallback, Object)

When implemented in a derived class, represents the beginning of the LoadIfChanged phase. The LoadIfChanged phase occurs when state data is loaded into the persistence provider from the persistence store and the state data in the persistence store has been changed. This method call does not lock the instance in the persistence store.

BeginLoadIfChanged(TimeSpan, Object, Boolean, AsyncCallback, Object)

When implemented in a derived class, represents the beginning of the LoadIfChanged phase. The LoadIfChanged phase occurs when state data is loaded into the persistence provider from the persistence store and the state data in the persistence store has been changed. This method call lets you specify whether you want to lock the instance in the persistence store.

BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.

(Inherited from CommunicationObject)
BeginUnlock(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to unlock an instance in the persistence store.

BeginUpdate(Object, TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to update instance state information in the persistence store using the parameters passed. This operation does not unlock the instance in the instance store.

BeginUpdate(Object, TimeSpan, Boolean, AsyncCallback, Object)

Begins an asynchronous operation to update instance state information in the persistence store using the parameters passed. This operation locks the instance in the persistence store if the value of the unlockInstance parameter is true.

Close()

Causes a communication object to transition from its current state into the closed state.

(Inherited from CommunicationObject)
Close(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

(Inherited from CommunicationObject)
Create(Object, TimeSpan)

Creates instance state information in the persistence store using parameters passed into the method. This method does not unlock the instance in the persistence store after saving the instance state.

Create(Object, TimeSpan, Boolean)

This method creates instance state information in the persistence store using parameters passed into the method. The method unlocks the instance in the instance store if the value of the unlockInstance parameter is true.

Delete(Object, TimeSpan)

When implemented in a derived class, permanently deletes service state information from the persistence store.

(Inherited from PersistenceProvider)
EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

(Inherited from CommunicationObject)
EndCreate(IAsyncResult)

When implemented in a derived class, represents the end of the Create phase. The Create phase occurs when service state records are first created in the persistence store.

(Inherited from PersistenceProvider)
EndDelete(IAsyncResult)

When implemented in a derived class, represents the end of the Delete phase. The Delete phase occurs when state data is permanently deleted from the persistence store.

(Inherited from PersistenceProvider)
EndLoad(IAsyncResult)

When implemented in a derived class, represents the end of the Load phase. The Load phase occurs when state data is loaded into the persistence provider from the persistence store.

(Inherited from PersistenceProvider)
EndLoadIfChanged(IAsyncResult, Object)

When implemented in a derived class, represents the end of the LoadIfChanged phase. The LoadIfChanged phase occurs when state data is loaded into the persistence provider from the persistence store, and the state data in the persistence store has been changed.

(Inherited from PersistenceProvider)
EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

(Inherited from CommunicationObject)
EndUnlock(IAsyncResult)

Ends the asynchronous operation to unlock an instance in the persistence store.

EndUpdate(IAsyncResult)

Represents the end of the Update phase. The Update phase occurs when service state records are updated in the persistence store.

(Inherited from PersistenceProvider)
Equals(Object)

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

(Inherited from Object)
Fault()

Causes a communication object to transition from its current state into the faulted state.

(Inherited from CommunicationObject)
GetCommunicationObjectType()

Gets the type of communication object.

(Inherited from CommunicationObject)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
Load(TimeSpan)

Loads service state information from the persistence store without locking the instance.

Load(TimeSpan, Boolean)

Loads state information from the persistence store after locking the instance.

LoadIfChanged(TimeSpan, Object, Boolean, Object)

Loads the instance state information from the persistence store if the state information has been changed since the last time the information was loaded by the caller. This method also lets the caller specify whether to lock the instance in the persistence store.

LoadIfChanged(TimeSpan, Object, Object)

Loads the instance state information from the persistence store if the state information has been changed since the last time the information was loaded by the caller. This method does not lock the instance in the persistence store.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnAbort()

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation.

(Inherited from CommunicationObject)
OnBeginClose(TimeSpan, AsyncCallback, Object)

Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.

(Inherited from CommunicationObject)
OnBeginOpen(TimeSpan, AsyncCallback, Object)

Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation.

(Inherited from CommunicationObject)
OnClose(TimeSpan)

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.

(Inherited from CommunicationObject)
OnClosed()

Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnClosing()

Invoked during the transition of a communication object into the closing state.

(Inherited from CommunicationObject)
OnEndClose(IAsyncResult)

Completes an asynchronous operation on the close of a communication object.

(Inherited from CommunicationObject)
OnEndOpen(IAsyncResult)

Completes an asynchronous operation on the open of a communication object.

(Inherited from CommunicationObject)
OnFaulted()

Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation.

(Inherited from CommunicationObject)
OnOpen(TimeSpan)

Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time.

(Inherited from CommunicationObject)
OnOpened()

Invoked during the transition of a communication object into the opened state.

(Inherited from CommunicationObject)
OnOpening()

Invoked during the transition of a communication object into the opening state.

(Inherited from CommunicationObject)
Open()

Causes a communication object to transition from the created state into the opened state.

(Inherited from CommunicationObject)
Open(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.

(Inherited from CommunicationObject)
ThrowIfDisposed()

Throws an exception if the communication object is disposed.

(Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()

Throws an exception if the communication object the State property is not set to the Created state.

(Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()

Throws an exception if the communication object is not in the Opened state.

(Inherited from CommunicationObject)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unlock(TimeSpan)

Unlocks the instance whose ID is specified when constructing the LockingPersistenceProvider object in the persistence store.

Update(Object, TimeSpan)

When implemented in a derived class, updates the instance state information in the persistence store. This method does not unlock the instance after updating the instance state information in the persistence store.

Update(Object, TimeSpan, Boolean)

When implemented in a derived class, updates the instance state information in the persistence store. This method does not unlock the instance after updating the instance state information in the persistence store.

Events

Closed

Occurs when a communication object transitions into the closed state.

(Inherited from CommunicationObject)
Closing

Occurs when a communication object transitions into the closing state.

(Inherited from CommunicationObject)
Faulted

Occurs when a communication object transitions into the faulted state.

(Inherited from CommunicationObject)
Opened

Occurs when a communication object transitions into the opened state.

(Inherited from CommunicationObject)
Opening

Occurs when a communication object transitions into the opening state.

(Inherited from CommunicationObject)

Applies to