ChangeBatchBase Class

  • Article

When overridden by a derived class, represents metadata for a set of changes.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.ChangeBatchBase
    Microsoft.Synchronization.ChangeBatch
    Microsoft.Synchronization.FullEnumerationChangeBatch

Namespace:  Microsoft.Synchronization
Assembly:  Microsoft.Synchronization (in Microsoft.Synchronization.dll)

Syntax

'Declaration
Public MustInherit Class ChangeBatchBase _
    Implements IDisposable, IEnumerable(Of ItemChange),  _
    IEnumerable
'Usage
Dim instance As ChangeBatchBase

public abstract class ChangeBatchBase : IDisposable, 
    IEnumerable<ItemChange>, IEnumerable

public ref class ChangeBatchBase abstract : IDisposable, 
    IEnumerable<ItemChange^>, IEnumerable

[<AbstractClassAttribute>]
type ChangeBatchBase =  
    class
        interface IDisposable
        interface IEnumerable<ItemChange>
        interface IEnumerable
    end

public abstract class ChangeBatchBase implements IDisposable, IEnumerable<ItemChange>, IEnumerable

The ChangeBatchBase type exposes the following members.

Properties

  Name Description
Public property BatchWorkEstimate Gets or sets the total work estimate for the change batch.
Public property CompatibilityLevel Gets or sets the version of Sync Framework components that can be used with this object.
Public propertyStatic member DefaultCompatibilityLevel Gets or sets the default compatibility level of all ChangeBatchBase objects.
Public property DisposeAfterProcessing Gets or sets a value that indicates whether the change batch object is disposed after processing finishes.
Public property FilterKeyMap Gets or set the filter key map that contains the filters tracked by the replica that originated this change batch.
Public property IsEmpty Gets a value that indicates whether the change batch contains any changes.
Public property IsLastBatch Gets a value that indicates whether this is the last batch in the synchronization session.
Public property LearnedKnowledge Gets the knowledge that the destination replica learns when the destination provider applies all the changes in this change batch.
Public property PrerequisiteKnowledge Gets the minimum knowledge that a destination provider is required to have to process this change batch.
Public property RemainingSessionWorkEstimate Gets or sets the remaining work estimate for the synchronization session.
Public property SourceForgottenKnowledge Gets the forgotten knowledge of the source replica.

Top

Methods

  Name Description
Public method AddChange Adds a specified item change to the group that is currently open
Public method AddChanges Adds a specified set of item changes to the group that currently open
Public method BeginOrderedGroup Opens an ordered group in the change batch. This group is ordered by item ID.
Public method Dispose() Releases all resources used by the ChangeBatchBase object.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ChangeBatchBase object and optionally releases the managed resources.
Public method EndOrderedGroup Closes a previously opened ordered group in the change batch.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Gets an object that enumerates the item changes in this change batch. This method cannot be inherited.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Serialize Serializes the change batch to an array of bytes.
Public method SetFilterForgottenKnowledge Sets the filter forgotten knowledge for the specified filter.
Public method SetLastBatch Sets a value that indicates that this is the last batch in the synchronization session.
Protected method ThrowIfDisposed Throws ObjectDisposedException if this object has been disposed.
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Gets an object that enumerates the item changes in this change batch.

Top

Remarks

ChangeBatchBase is the base class for change batches. Sync Framework provides two classes that are derived from ChangeBatchBase. These are ChangeBatch for a knowledge synchronization and FullEnumerationChangeBatch for a full enumeration synchronization.

The members of IEnumerable are implemented explicitly. Code that accesses them must first cast the ChangeBatchBase object to the IEnumerable interface by using the casting operator or the as keyword.

Thread Safety

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

See Also

Reference

Microsoft.Synchronization Namespace