SimpleSyncProvider Class

Article
10/22/2010

Represents a simple provider that is used to synchronize a replica. You will typically extend FullEnumerationSimpleSyncProvider or AnchorEnumerationSimpleSyncProvider.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.SyncProvider
    Microsoft.Synchronization.SimpleProviders.SimpleSyncProvider
      Microsoft.Synchronization.SimpleProviders.AnchorEnumerationSimpleSyncProvider
      Microsoft.Synchronization.SimpleProviders.FullEnumerationSimpleSyncProvider

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

Syntax

'Declaration
Public MustInherit Class SimpleSyncProvider _
    Inherits SyncProvider
'Usage
Dim instance As SimpleSyncProvider

public abstract class SimpleSyncProvider : SyncProvider

public ref class SimpleSyncProvider abstract : public SyncProvider

[<AbstractClassAttribute>]
type SimpleSyncProvider =  
    class
        inherit SyncProvider
    end

public abstract class SimpleSyncProvider extends SyncProvider

The SimpleSyncProvider type exposes the following members.

Constructors

	Name	Description
	SimpleSyncProvider	Initializes a new instance of the SimpleSyncProvider class.

Top

Properties

	Name	Description
	Configuration	When overridden in a derived class, gets a KnowledgeSyncProviderConfiguration object that represents configuration information for a provider, such as the conflict resolution policy.
	DestinationCallbacks	When overridden in a derived class, gets a SyncCallbacks object that is used to dispatch a synchronization event.
	IdFormats	When overridden in a derived class, gets a SyncIdFormatGroup object that represents the format of replica and item IDs.
	MetadataSchema	When overridden in a derived class, gets an ItemMetadataSchema object that represents the metadata schema for an item.
	ProviderVersion	When overridden in a derived class, gets the version number for the simple provider.

Top

Methods

	Name	Description
	BeginSession	When overridden in a derived class, called by the Sync Framework runtime at the start of each session.
	DeleteItem	When overridden in a derived class, called by the Sync Framework runtime to delete an item from the destination store.
	EndSession	When overridden in a derived class, called by the Sync Framework runtime at the end of each session unless a session is terminated because of an exception.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetMetadataStore	When overridden in a derived class, called by the Sync Framework runtime to return a MetadataStore object for a replica.
	GetType	(Inherited from Object.)
	InsertItem	When overridden in a derived class, called by the Sync Framework runtime to insert an item into the destination store.
	LoadChangeData	When overridden in a derived class, called by the Sync Framework runtime to load the change data for the item with the specified key.
	MemberwiseClone	(Inherited from Object.)
	OnChangeDetectionCompleted	When overridden in a derived class, raises the ChangeDetectionCompleted event.
	OnItemConflicting	When overridden in a derived class, raises the ItemConflicting event.
	OnItemConstraint	When overridden in a derived class, raises the ItemConstraint event.
	OnMetadataStoreInitialized	When overridden in a derived class, raises the MetadataStoreInitialized event.
	ToString	(Inherited from Object.)
	UpdateItem	When overridden in a derived class, called by the Sync Framework runtime to update an item in the destination store.

Top

Events

	Name	Description
	ChangeDetectionCompleted	Occurs when change detection is complete for a source provider.
	ItemConflicting	Occurs when Sync Framework detects that an item being processed is involved in a concurrency conflict.
	ItemConstraint	Occurs when Sync Framework detects that an item being processed is involved in a constraint conflict.
	MetadataStoreInitialized	Occurs when the metadata store that is associated with a provider is initialized.

Top

Remarks

The simple provider API is designed primarily for two types of replicas:

Replicas that do not support any kind of change tracking. This type of replica uses a full enumeration provider (FullEnumerationSimpleSyncProvider), which enumerates all items from the source replica every time synchronization occurs.
Replicas that support anchor-based change tracking. This type of replica uses an anchor-based provider (AnchorEnumerationSimpleSyncProvider), which enumerates the items from the source replica that changed after a specific anchor was set, which is typically a point in time.

For more information about simple providers, see How to: Create a Managed Simple Provider. For more information about custom providers in general, see Custom Provider Fundamentals, especially the section "Deciding Between a Simple Provider and a Standard Provider".

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.

Share via