Como rastrear o processo de sincronização
Este tópico mostra como usar a infraestrutura de rastreamento e a classe de rastreamento do Sync Framework. Os exemplos neste tópico se concentram nos seguintes eventos e tipos do Sync Framework:
Para obter informações sobre como executar o código de exemplo, consulte "Exemplo de aplicativos nos tópicos de instruções" em Programando tarefas comuns de sincronização do cliente e do servidor.
Entendendo o rastreamento nos serviços de sincronização
O rastreamento envolve registrar operações, dados e metadados de aplicativo e apresentar essas informações a um ouvinte. Um ouvinte com frequência grava informações de rastreamento em um arquivo, mas também pode trabalhar com elas de outras maneiras. O Sync Framework inclui rastreamento para os provedores de sincronização do cliente e do servidor. Em aplicativos distribuídos, o rastreamento pode ser muito importante porque permite solucionar problemas que poderiam ser difíceis de descobrir.
No Sync Framework o rastreamento é formado pelos seguintes componentes:
Uma infraestrutura de rastreamento baseada na implementação .NET Framework de rastreamento, especificamente a classe TraceListener. As operações mais importantes dos provedores do cliente e do servidor são rastreadas, e os principais metadados são fornecidos para um ou mais ouvintes.
O objeto SyncTracer. Ele permite determinar qual nível de rastreamento está habilitado e gravar mensagens na saída de rastreamento com base em eventos de aplicativo.
Além dos componentes de rastreamento oferecidos pelo Sync Framework, a solução de problemas geralmente envolve outras ferramentas, como um depurador ou o SQL Server Profiler. Por exemplo, a saída de rastreamento poderia incluir informações sobre um banco de dados do SQL Server. Nesse caso, você usaria o SQL Server Profiler para obter mais detalhes sobre a atividade de banco de dados gerada pelo provedor de sincronização do servidor.
Usando a infraestrutura de rastreamento
Por padrão, o rastreamento não está habilitado para aplicativos do Sync Framework. Para configurar um ouvinte de rastreamento, edite o arquivo app.config do aplicativo. Para obter mais informações sobre esse arquivo, consulte a documentação do Visual Studio. Nesse arquivo, é possível adicionar um ouvinte, definir seu tipo e os parâmetros relacionados, remover um ouvinte ou limpar todos os ouvintes que anteriormente foram definidos pelo aplicativo. Para obter mais informações, consulte a documentação do .NET Framework sobre rastreamento. O arquivo de configuração deve ser parecido com o exemplo a seguir.
<configuration>
<system.diagnostics>
<switches>
<!-- 0-off, 1-error, 2-warn, 3-info, 4-verbose. -->
<add name="SyncTracer" value="3" />
</switches>
<trace autoflush="true">
<listeners>
<add name="TestListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\TraceSample.txt"/>
</listeners>
</trace>
</system.diagnostics>
</configuration>
Os seguintes nós XML são incluídos no código de exemplo:
Um ouvinte do tipo
System.Diagnostics.TextWriterTraceListener(TextWriterTraceListener), com o caminho para:c:\TraceSample.txt.Uma opção chamada
SyncTracer. Ela tem um valor igual a3. A tabela a seguir mostra todos os valores e como eles estão relacionados com a saída de rastreamento.Valor da opção Nível de rastreamento Saída 0offNenhuma mensagem para os ouvintes de rastreamento.
1errorApenas mensagens de erro para os ouvintes de rastreamento.
2warningMensagens de erro e de aviso para os ouvintes de rastreamento.
3infoMensagens informativas, de aviso e de erro para os ouvintes de rastreamento.
4verboseTodas as mensagens para os ouvintes de rastreamento.
O rastreamento está com um pouco de sobrecarga. Por isso, você deve equilibrar o rastreamento em relação aos requisitos de desempenho do aplicativo. Na maioria dos casos, as configurações
infoeverbosesó são apropriadas durante o desenvolvimento e a solução de problemas do aplicativo.
O arquivo de configuração a seguir mostra um exemplo para dispositivos.
<configuration>
<traceSettings>
<add key ="FileLocation" value="TraceSample.txt"/>
<add key ="LogLevel" value="4"/>
</traceSettings>
</configuration>
O arquivo deve ser denominado trace.config.txt e deve ser colocado no diretório do aplicativo no dispositivo. Se você incluir o arquivo em uma solução do Visual Studio, ele pode ser implantado com o aplicativo.
O segmento de arquivo abaixo é de um rastreamento que foi configurado usando um valor SyncTracer igual a 3. Cada linha começa com o tipo de saída. Nesse caso, toda a saída é INFO. Se tivesse ocorrido um erro, as linhas relevantes começariam com ERROR.
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Connecting to server using string: Data Source=localhost;Initial Catalog=SyncSamplesDb;Integrated Security=True
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, ----- Server Enumerating Changes to Client for Group "Customer" -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Client Id: bc5610f6-bf9c-4ccd-8599-839e54e953e2
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Mapped Originator Id: 0
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042,
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042, ----- Enumerating Inserts for Table Customer -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, Changes Enumerated: 5
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, --- End Enumerating Inserts for Table Customer ---
Usando o objeto SyncTracer
O objeto SyncTracer permite gravar dados de rastreamento específicos do aplicativo no arquivo de rastreamento. Isso pode fornecer informações contextuais sobre a atividade de um aplicativo em um determinado horário. Este objeto permite executar as seguintes tarefas:
Determinar que nível de rastreamento está habilitado, usando estes métodos:
Gravar mensagens na saída de rastreamento com base em eventos de aplicativo, usando os métodos abaixo, e outras sobrecargas relacionadas a cada método:
Por exemplo, para gerar uma mensagem informativa, você pode usar o seguinte código:
SyncTracer.Info("Informational message")Se o nível Informações estiver habilitado, a mensagem será gravada na saída; do contrário, será ignorada.
Mensagens mais complexas também podem ser formadas, como as mostradas a seguir. Os números especificados definem o nível de recuo do arquivo de saída.
SyncTracer.Verbose("Processing table t1")SyncTracer.Verbose(1, "Applying Deletes")SyncTracer.Verbose(2, "{0} rows deleted", numDeleted)SyncTracer.Verbose(1, "Applying Inserts")SyncTracer.Verbose(2, "{0} rows inserted", numInserted)A saída é a seguinte:
Processing table t1Applying Deletes7 Rows DeletedApplying Inserts9 Rows inserted
O exemplo de código a seguir grava informações no console sobre quais níveis de rastreamento estão habilitados. O arquivo de configuração especifica um valor igual a 3 para a opção SyncTracer. Isso corresponde a Info. Portanto, Error, Warning e Info retornam True e Verbose retorna False.
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
O exemplo de código a seguir mostra como gravar mensagens de aviso formatadas sobre conflitos de dados na saída de rastreamento. Para obter mais informações sobre conflitos, consulte Como tratar conflitos de dados e erros. O rastreamento detalhado inclui informações sobre conflitos. Neste aplicativo, o rastreamento detalhado está desabilitado, e o aplicativo marca os conflitos com um aviso.
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
Verificar quais níveis de rastreamento estão habilitados pode ajudar você a evitar um processamento possivelmente dispendioso. No código do exemplo, o aplicativo evita processamento adicional se o rastreamento detalhado já está habilitado. De modo contrário, o aplicativo só poderá gerar saída quando um certo nível de rastreamento estiver habilitado.
Considerações de segurança do rastreamento
Os arquivos de rastreamento podem incluir informações sobre computadores cliente e servidor, dados de aplicativo e logons. (As senhas não são gravadas no arquivo de rastreamento.) Se o rastreamento detalhado estiver habilitado, cada linha alterada do banco de dados será gravada no arquivo de rastreamento. Para ajudar a proteger o arquivo de rastreamento, use as listas de controle de acesso apropriadas.
Exemplo de código completo
O exemplo de código completo a seguir inclui os exemplos de código descritos anteriormente neste tópico e código adicional para executar a sincronização. Antes de executar o aplicativo, execute estas etapas:
Crie um projeto no Visual Studio.
Adicione referências às DLLs do Sync Framework e à classe
Utilityque está disponível em Classe de utilitário para tópicos de instruções do provedor de banco de dados.Crie um arquivo de configuração e copie o código XML do exemplo mostrado anteriormente neste tópico.
Conheça as duas chamadas para métodos na classe Utility:
util.MakeFailingChangesOnClient()Isso faz uma alteração no cliente que falha quando aplicada ao servidor. A violação de restrição e a exceção de aplicativo relacionada são gravadas automaticamente no arquivo de rastreamento como avisos.util.MakeConflictingChangesOnClientAndServer()Isso faz alterações no cliente e no servidor que entram em conflito quando são sincronizadas. Os conflitos são gravados no arquivo de rastreamento, no manipulador de eventosSampleServerSyncProvider_ApplyChangeFailed.
Depois de executar o aplicativo, abra o arquivo de rastreamento de saída para ver: as mensagens gravadas automaticamente e os avisos de conflito, que são o resultado do código de aplicativo.
using System;
using System.IO;
using System.Text;
using System.Data;
using System.Data.SqlClient;
using System.Data.SqlServerCe;
using Microsoft.Synchronization;
using Microsoft.Synchronization.Data;
using Microsoft.Synchronization.Data.Server;
using Microsoft.Synchronization.Data.SqlServerCe;
namespace Microsoft.Samples.Synchronization
{
class Program
{
static void Main(string[] args)
{
//The SampleStats class handles information from the SyncStatistics
//object that the Synchronize method returns.
SampleStats sampleStats = new SampleStats();
//Delete and re-create the database. The client synchronization
//provider also enables you to create the client database
//if it does not exist.
Utility.SetPassword_SqlCeClientSync();
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, true);
//Write to the console which tracing levels are enabled. The app.config
//file specifies a value of 3 for the SyncTracer switch, which corresponds
//to Info. Therefore, Error, Warning, and Info return True, and Verbose
//returns False.
Console.WriteLine("");
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
//Initial synchronization. Instantiate the SyncAgent
//and call Synchronize.
SampleSyncAgent sampleSyncAgent = new SampleSyncAgent();
SyncStatistics syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "initial");
//Make a change at the client that fails when it is
//applied at the server. The constraint violation
//is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient();
//Make changes at the client and server that conflict
//when they are synchronized. The conflicts are written
//to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
//event handler.
Utility.MakeConflictingChangesOnClientAndServer();
//Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "subsequent");
//Return server data back to its original state.
Utility.CleanUpServer();
//Exit.
Console.Write("\nPress Enter to close the window.");
Console.ReadLine();
}
}
//Create a class that is derived from
//Microsoft.Synchronization.SyncAgent.
public class SampleSyncAgent : SyncAgent
{
public SampleSyncAgent()
{
//Instantiate a client synchronization provider and specify it
//as the local provider for this synchronization agent.
this.LocalProvider = new SampleClientSyncProvider();
//Instantiate a server synchronization provider and specify it
//as the remote provider for this synchronization agent.
this.RemoteProvider = new SampleServerSyncProvider();
//Add the Customer table: specify a synchronization direction of
//DownloadOnly.
SyncTable customerSyncTable = new SyncTable("Customer");
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable;
customerSyncTable.SyncDirection = SyncDirection.Bidirectional;
this.Configuration.SyncTables.Add(customerSyncTable);
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Server.DbServerSyncProvider.
public class SampleServerSyncProvider : DbServerSyncProvider
{
public SampleServerSyncProvider()
{
//Create a connection to the sample server database.
Utility util = new Utility();
SqlConnection serverConn = new SqlConnection(Utility.ConnStr_DbServerSync);
this.Connection = serverConn;
//Create a command to retrieve a new anchor value from
//the server. In this case, we use a timestamp value
//that is retrieved and stored in the client database.
//During each synchronization, the new anchor value and
//the last anchor value from the previous synchronization
//are used: the set of changes between these upper and
//lower bounds is synchronized.
//
//SyncSession.SyncNewReceivedAnchor is a string constant;
//you could also use @sync_new_received_anchor directly in
//your queries.
SqlCommand selectNewAnchorCommand = new SqlCommand();
string newAnchorVariable = "@" + SyncSession.SyncNewReceivedAnchor;
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1";
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp);
selectNewAnchorCommand.Parameters[newAnchorVariable].Direction = ParameterDirection.Output;
selectNewAnchorCommand.Connection = serverConn;
this.SelectNewAnchorCommand = selectNewAnchorCommand;
//Create a SyncAdapter for the Customer table by using
//the SqlSyncAdapterBuilder:
// * Specify the base table and tombstone table names.
// * Specify the columns that are used to track when
// and where changes are made.
// * Specify bidirectional synchronization.
// * Call ToSyncAdapter to create the SyncAdapter.
// * Specify a name for the SyncAdapter that matches the
// the name specified for the corresponding SyncTable.
// Do not include the schema names (Sales in this case).
SqlSyncAdapterBuilder customerBuilder = new SqlSyncAdapterBuilder(serverConn);
customerBuilder.TableName = "Sales.Customer";
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone";
customerBuilder.SyncDirection = SyncDirection.Bidirectional;
customerBuilder.CreationTrackingColumn = "InsertTimestamp";
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp";
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp";
customerBuilder.CreationOriginatorIdColumn = "InsertId";
customerBuilder.UpdateOriginatorIdColumn = "UpdateId";
customerBuilder.DeletionOriginatorIdColumn = "DeleteId";
SyncAdapter customerSyncAdapter = customerBuilder.ToSyncAdapter();
customerSyncAdapter.TableName = "Customer";
this.SyncAdapters.Add(customerSyncAdapter);
//Handle the ApplyChangeFailed event. This allows us to write
//information to the trace file about any conflicts that occur.
this.ApplyChangeFailed += new EventHandler<ApplyChangeFailedEventArgs>(SampleServerSyncProvider_ApplyChangeFailed);
}
private void SampleServerSyncProvider_ApplyChangeFailed(object sender, ApplyChangeFailedEventArgs e)
{
//Verbose tracing includes information about conflicts. In this application,
//Verbose tracing is disabled, and we have decided to flag conflicts with a
//warning.
//Check if Verbose tracing is enabled and if the conflict is an error.
//If the conflict is not an error, we write a warning to the trace file
//with information about the conflict.
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
//You can just instantiate the provider directly and associate it
//with the SyncAgent, but you could use this class to handle client
//provider events and other client-side processing.
public class SampleClientSyncProvider : SqlCeClientSyncProvider
{
public SampleClientSyncProvider()
{
//Specify a connection string for the sample client database.
Utility util = new Utility();
this.ConnectionString = Utility.ConnStr_SqlCeClientSync;
this.SchemaCreated += new EventHandler<SchemaCreatedEventArgs>(SampleClientSyncProvider_SchemaCreated);
}
private void SampleClientSyncProvider_SchemaCreated(object sender, SchemaCreatedEventArgs e)
{
string tableName = e.Table.TableName;
Utility util = new Utility();
//Call ALTER TABLE on the client. This must be done
//over the same connection and within the same
//transaction that Sync Framework uses
//to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer");
}
}
//Handle the statistics that are returned by the SyncAgent.
public class SampleStats
{
public void DisplayStats(SyncStatistics syncStatistics, string syncType)
{
Console.WriteLine(String.Empty);
if (syncType == "initial")
{
Console.WriteLine("****** Initial Synchronization ******");
}
else if (syncType == "subsequent")
{
Console.WriteLine("***** Subsequent Synchronization ****");
}
Console.WriteLine("Start Time: " + syncStatistics.SyncStartTime);
Console.WriteLine("Total Changes Downloaded: " + syncStatistics.TotalChangesDownloaded);
Console.WriteLine("Total Changes Uploaded: " + syncStatistics.TotalChangesUploaded);
Console.WriteLine("Complete Time: " + syncStatistics.SyncCompleteTime);
Console.WriteLine(String.Empty);
}
}
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Data
Imports System.Data.SqlClient
Imports System.Data.SqlServerCe
Imports Microsoft.Synchronization
Imports Microsoft.Synchronization.Data
Imports Microsoft.Synchronization.Data.Server
Imports Microsoft.Synchronization.Data.SqlServerCe
Class Program
Shared Sub Main(ByVal args() As String)
'The SampleStats class handles information from the SyncStatistics
'object that the Synchronize method returns.
Dim sampleStats As New SampleStats()
'Delete and re-create the database. The client synchronization
'provider also enables you to create the client database
'if it does not exist.
Utility.SetPassword_SqlCeClientSync()
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, True)
'Write to the console which tracing levels are enabled. The app.config
'file specifies a value of 3 for the SyncTracer switch, which corresponds
'to Info. Therefore, Error, Warning, and Info return True, and Verbose
'returns False.
Console.WriteLine("")
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
'Initial synchronization. Instantiate the SyncAgent
'and call Synchronize.
Dim sampleSyncAgent As New SampleSyncAgent()
Dim syncStatistics As SyncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "initial")
'Make a change at the client that fails when it is
'applied at the server. The constraint violation
'is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient()
'Make changes at the client and server that conflict
'when they are synchronized. The conflicts are written
'to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
'event handler.
Utility.MakeConflictingChangesOnClientAndServer()
'Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "subsequent")
'Return server data back to its original state.
Utility.CleanUpServer()
'Exit.
Console.Write(vbLf + "Press Enter to close the window.")
Console.ReadLine()
End Sub 'Main
End Class 'Program
'Create a class that is derived from
'Microsoft.Synchronization.SyncAgent.
Public Class SampleSyncAgent
Inherits SyncAgent
Public Sub New()
'Instantiate a client synchronization provider and specify it
'as the local provider for this synchronization agent.
Me.LocalProvider = New SampleClientSyncProvider()
'Instantiate a server synchronization provider and specify it
'as the remote provider for this synchronization agent.
Me.RemoteProvider = New SampleServerSyncProvider()
'Add the Customer table: specify a synchronization direction of
'DownloadOnly.
Dim customerSyncTable As New SyncTable("Customer")
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable
customerSyncTable.SyncDirection = SyncDirection.Bidirectional
Me.Configuration.SyncTables.Add(customerSyncTable)
End Sub 'New
End Class 'SampleSyncAgent
'Create a class that is derived from
'Microsoft.Synchronization.Server.DbServerSyncProvider.
Public Class SampleServerSyncProvider
Inherits DbServerSyncProvider
Public Sub New()
'Create a connection to the sample server database.
Dim util As New Utility()
Dim serverConn As New SqlConnection(Utility.ConnStr_DbServerSync)
Me.Connection = serverConn
'Create a command to retrieve a new anchor value from
'the server. In this case, we use a timestamp value
'that is retrieved and stored in the client database.
'During each synchronization, the new anchor value and
'the last anchor value from the previous synchronization
'are used: the set of changes between these upper and
'lower bounds is synchronized.
'
'SyncSession.SyncNewReceivedAnchor is a string constant;
'you could also use @sync_new_received_anchor directly in
'your queries.
Dim selectNewAnchorCommand As New SqlCommand()
Dim newAnchorVariable As String = "@" + SyncSession.SyncNewReceivedAnchor
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1"
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp)
selectNewAnchorCommand.Parameters(newAnchorVariable).Direction = ParameterDirection.Output
selectNewAnchorCommand.Connection = serverConn
Me.SelectNewAnchorCommand = selectNewAnchorCommand
'Create a SyncAdapter for the Customer table by using
'the SqlSyncAdapterBuilder:
' * Specify the base table and tombstone table names.
' * Specify the columns that are used to track when
' and where changes are made.
' * Specify bidirectional synchronization.
' * Call ToSyncAdapter to create the SyncAdapter.
' * Specify a name for the SyncAdapter that matches the
' the name specified for the corresponding SyncTable.
' Do not include the schema names (Sales in this case).
Dim customerBuilder As New SqlSyncAdapterBuilder(serverConn)
customerBuilder.TableName = "Sales.Customer"
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone"
customerBuilder.SyncDirection = SyncDirection.Bidirectional
customerBuilder.CreationTrackingColumn = "InsertTimestamp"
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp"
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp"
customerBuilder.CreationOriginatorIdColumn = "InsertId"
customerBuilder.UpdateOriginatorIdColumn = "UpdateId"
customerBuilder.DeletionOriginatorIdColumn = "DeleteId"
Dim customerSyncAdapter As SyncAdapter = customerBuilder.ToSyncAdapter()
customerSyncAdapter.TableName = "Customer"
Me.SyncAdapters.Add(customerSyncAdapter)
'Handle the ApplyChangeFailed event. This allows us to write
'information to the trace file about any conflicts that occur.
AddHandler Me.ApplyChangeFailed, AddressOf SampleServerSyncProvider_ApplyChangeFailed
End Sub 'New
Private Sub SampleServerSyncProvider_ApplyChangeFailed(ByVal sender As Object, ByVal e As ApplyChangeFailedEventArgs)
'Verbose tracing includes information about conflicts. In this application,
'Verbose tracing is disabled, and we have decided to flag conflicts with a
'warning.
'Check if Verbose tracing is enabled and if the conflict is an error.
'If the conflict is not an error, we write a warning to the trace file
'with information about the conflict.
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
End Sub 'SampleServerSyncProvider_ApplyChangeFailed
End Class 'SampleServerSyncProvider
'Create a class that is derived from
'Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
'You can just instantiate the provider directly and associate it
'with the SyncAgent, but you could use this class to handle client
'provider events and other client-side processing.
Public Class SampleClientSyncProvider
Inherits SqlCeClientSyncProvider
Public Sub New()
'Specify a connection string for the sample client database.
Dim util As New Utility()
Me.ConnectionString = Utility.ConnStr_SqlCeClientSync
End Sub 'New
Private Sub SampleClientSyncProvider_SchemaCreated(ByVal sender As Object, ByVal e As SchemaCreatedEventArgs)
Dim tableName As String = e.Table.TableName
Dim util As New Utility()
'Call ALTER TABLE on the client. This must be done
'over the same connection and within the same
'transaction that Sync Framework uses
'to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer")
End Sub 'SampleClientSyncProvider_SchemaCreated
End Class 'SampleClientSyncProvider
'Handle the statistics that are returned by the SyncAgent.
Public Class SampleStats
Public Sub DisplayStats(ByVal syncStatistics As SyncStatistics, ByVal syncType As String)
Console.WriteLine(String.Empty)
If syncType = "initial" Then
Console.WriteLine("****** Initial Synchronization ******")
ElseIf syncType = "subsequent" Then
Console.WriteLine("***** Subsequent Synchronization ****")
End If
Console.WriteLine("Start Time: " & syncStatistics.SyncStartTime)
Console.WriteLine("Total Changes Downloaded: " & syncStatistics.TotalChangesDownloaded)
Console.WriteLine("Total Changes Uploaded: " & syncStatistics.TotalChangesUploaded)
Console.WriteLine("Complete Time: " & syncStatistics.SyncCompleteTime)
Console.WriteLine(String.Empty)
End Sub 'DisplayStats
End Class 'SampleStats
Consulte também
Conceitos
Programando tarefas comuns de sincronização do cliente e do servidor