Pro Sync Framework

1
Benefits of Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Life Before Sync Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Why the Microsoft Sync Framework? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing Microsoft Sync Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Core Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Synchronization Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Sync Framework Participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Synchronization Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Synchronizing Two Replicas Using Built-in Providers . . . . . . . . . . . . . . . 11
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
■CHAPTER 2 Microsoft Sync Framework Metadata . . . . . . . . . . . . . . . . . . . . 19
What Is Sync Metadata? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Metadata Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Components of Sync Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Example of Sync Metadata Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Sync Metadata Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
■CHAPTER 3 Working with Synchronization Providers: Part 1 . . . . . . . . 33
What Is a Sync Provider? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Synchronizing Two Replicas Using Built-in Providers . . . . . . . . . . . . . . . 35
Creating a Synchronization Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Provider Writer Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Change Tracking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Change Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Conflict Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Conflict Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Resolving Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Saving the Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Sample Synchronization Provider for Synchronizing
SQL Server Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
MySyncProvider.cs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Overriding Provider Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Creating New Customer Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Synchronizing Replicas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Running the Sample Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Synchronizing New Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Detecting and Handling Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Synchronize Deleted Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Finishing Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
■CHAPTER 4 Working with Synchronization Providers: Part 2 . . . . . . . . 91
Change Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Creating Sync Providers with Change Units. . . . . . . . . . . . . . . . . . . . 94
Creating Providers That Use Asynchronous Change Tracking . . . . . . . . . 94
MySyncProvider.cs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Changing the Customer.cs Class . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Changes in the Synchronizing Application. . . . . . . . . . . . . . . . . . . . 104
Creating a Generic Sync Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
BaseSyncProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Extending the Generic Sync Provider Class . . . . . . . . . . . . . . . . . . . 109
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
■CHAPTER 5 Working with File Synchronization Providers . . . . . . . . . . . 119
Sync Framework Core Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
File Sync Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
File Sync Provider Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120