Class provides core functionallity to synchronize data with DataPlace.
Remarks
Remarks
Often utilized with CS.DataPlace.Distribution.Client.SyncStatusDialog (WinForm)
or CS.DataPlace.Distribution.Client.Wpf.SyncStatusDialog to provide a user interface to monitor and control the synchronization
Declaration Syntax| C# |
public class SynchronizationClient : IDisposableNotify, IDisposable, IProgressHandler, INotifyPropertyChanged
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | SynchronizationClient(DBType, String) |
c'tor
|
| SynchronizationClient(DBType, String, Guid, Guid) |
c'tor
|
| SynchronizationClient(DBType, String, Guid, Guid, Nullable<(Of <(Boolean>)>)) |
c'tor
|
| SynchronizationClient(DBType, String, Guid, Guid, Nullable<(Of <(Boolean>)>), String) |
c'tor
|
  | ActiveSynchronizationClients |
All non disposed syncmanagers
|
| AutoSyncEnabled |
Gets or sets whether automatic, periodic synchronization will be performed while the
application is running.
|
| AutoSyncFrequency |
Gets or sets the frequency at which synchronization will be automatically performed, in minutes.
|
| CancelSynchronization()()() |
Cancels a sync
|
| CheckIsDatabaseReady()()() |
Checks that the database exists and programmability is up to date.
First caller to this method will incurr delay as check is performed
Use IsDatabaseReady as a non-impactful way to check
|
| CheckIsDatabaseReady(Boolean) |
Checks that the database exists and programmability is up to date.
First caller to this method will incurr delay as check is performed
Use [!:IsDatabaseReadyNoCheck] as a non-impactful way to check
|
| CheckIsDatabaseReadyAsync(Boolean) | |
| CleanDataFolder()()() |
Removes old/historic temporary files from the DefaultDataFolder
|
| CleanDataFolder(String) |
Removes old/historic temporary files from the specified path
|
| ClientConnectionString |
Base connection string to the client database
|
| ClientDbName |
Database name for the client database
|
| ClientType |
Indicates the type of client database handled by this sychronization client
|
| CloseClient()()() |
Closes the sycnhronization wcf client
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
 | CredentialsRequired |
Must be handled in a stand alone application.
Event raised when credential are required for DataPlace or a Proxy server
Remarks |
| CurrentClientSchema |
Provides a series of classes that desribe the structure of the client database regardless of the client database type
|
| CurrentEnrollmentInfo |
The Enrollment as defined in the last synchronization.
|
| DatabaseReady |
Occurs when the Database is now ready at the completion of a sync or a reinit.
|
| DatabaseReadyOwner |
Indicates as a string the SynchronizationClient (or external application) that owns the DatabaseReady check mutex
|
| DatabaseReadyPercentage |
1 if the database is ready for use, scales between 0 and 0.8 during the initial synchronization of a new database
Intended for animation effects
|
| DataRootPath |
Root path used by this synchronization client for the client database and temporary synchronization folders
|
 | DefaultAutoSyncEnabled |
Default value for AutoSyncEnabled
|
| DefaultAutoSyncFrequency |
Default value for AutoSyncFrequency
|
| DefaultDataRootPath |
Default file path location for DataPlace VistaDB databases and temporary synchronization folders
|
| DisplayName |
Display name for this synchronization client, typically the name of the Database or Distribuiton.
This value is specified by the application utilizing the Synchronization Client
|
| Dispose()()() |
Dispose of object
|
 | Dispose(Boolean) |
Dipose of object
|
| Disposing |
Event raised at the beginning of a Dispose on this object
|
| DownloaderOwner |
Indicates as a string the SynchronizationClient (or external application) that owns the Downloader mutex
|
| DownloadPackage(Guid) |
Peforms the DownloadPackage phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
 | DPDSyncMinVersionForReload |
Minimum assembly version number for synchronization
|
| EngineProgress |
Raw progress events for the current instance of the package engine
|
| Equals(Object) | (Inherited from Object.) |
| Finalize()()() |
Finalizer
(Overrides Object.Finalize()()().) |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| InitialPackOwner |
Indicates as a string the SynchronizationClient (or external application) that owns the Initial Pack (first sync of a new database) mutex
|
| IsDatabaseReady |
Will return database ready state as last determined. No check will be performed if it has not already occurred.
Use CheckIsDatabaseReady()()() to ensure a check is performed synchronously
Or attach to DatabaseReady event as a asynchronous way to be notified.
|
| IsDisposed |
True when this object is currently disposed
|
| IsDisposing |
True when this object is currently disposing
|
| IsNew |
Indicates that this synchronization is creating a new client database for a first time sync.
|
| IsRemovingDatabase |
True if the synchronizationclient is attempting to remove the client database
|
| IsUserDatabase |
Indicates that this is a standard DataPlace database
|
| LastStartTime |
DateTime the last synchronize began
|
| LastSynchronized |
DateTime the last synchronization completed
|
| LastSyncLog |
Represents the detailed synchronization log of the last complete or currently executing synchronization.
|
| LocalOperationOwner |
Indicates as a string the SynchronizationClient (or external application) that owns the Local Operation mutex
|
| MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| MoveAbanondedFiles(Boolean) |
Moves abanonded temporary files out of the working folder
|
| OnDatabaseReady(EventArgs) |
Raises the DatabaseReady event
|
| OnDisposing(EventArgs) |
Raises the Disposing event
|
| OnEngineProgress(ProgressEventArgs) |
Raised the EngineProgress event
|
| OnProgress(SynchronizationProgressEventArgs) |
Raises the Progress event
|
| OnPropertyChanged(String) |
Raises the PropertyChanged event
|
| OnRemovingDatabase(EventArgs) |
Raised the RemovingDatabase event
|
| OnSynchronizationComplete(QueuedWorkItemCompletedEventArgs) |
Raises the SynchronizationComplete event
|
| OnSynchronizationStarting(CancelEventArgs) |
Raises the SynchronizationStarting event
|
| OnTableUpdated(TableUpdateEventArgs) |
Raises the TableUpdated event
|
| OpenClient(Boolean) |
Opens the sycnhronization wcf client
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| PackageFromClient(Int64%) |
Peforms the PackageFromClient phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| PackageFromServer(String%) |
Peforms the PackageFromServer phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| PerformingSync |
True when this syncrhonization client is actively synchroning
|
| PerformingUnpackToClient |
True when performing the unpack of data and schema to the client database
Remarks
In some cases, applications may choose to delay data refreshes during this phase to ensure more current data.
|
| Progress |
Event that is raised during a sync to indicate progress
|
| PropertyChanged |
Raised when a property is changed
|
| RemoveDatabase()()() |
Removes the local database.
|
| RemovingDatabase |
Occurs before the database is removed
|
| ResolvedConnectionString |
Full ADO.Net compatible connection string to the client database
|
| SetIsDatabaseReady(Boolean) |
Sets the Database Ready status
|
| SetPhase(String, Double) |
Sets the phase of the current sync process
|
| SetProgress(String, Nullable<(Of <(Double>)>)) |
Sets new progress message on the current sync status
|
| SetProgress(Exception) |
Logs an exception as sync progress
|
 | SetProgress(ProgressEventArgs) |
Raises a Package Engine progress event as a SyncProgress Event
|
| ShouldRaiseDbReadyEvent |
True when at least one caller of IsDatabaseReady or IsDatabaseReadyNoCheck used those properties and received a false.
|
| StartSyncTimer()()() |
Enables the synchronization timer to sync on a regular interval
|
| StartSyncTimer(Int32) |
Enables the synchronization timer to sync on a regular interval
|
| StatusMessage |
Last status message for current/last sync
|
| StatusPercentage |
Percentage complete for current/last sync
|
| StatusPhaseName |
Phase name for current/last sync
|
| StatusPhaseStepMessage |
Concat. StatusPhaseName with StatusStepName
|
| StatusStepName |
Step name for current/last sync
|
| StopSyncTimer()()() |
Disables the synchronization timer to sync on a regular interval
|
| SynchronizationClientRemovingDatabase |
Static event that occurs when any SynchronizationClient is removing a database
|
| SynchronizationComplete |
Event after the completion of a async sync
|
| SynchronizationStarting |
Event prior to Start of a Async sync
|
| Synchronize(Boolean) |
Intended for internal or advanced use; use SynchronizeAsync.
|
| SynchronizeAsync()()() |
Starts a new asyncrhonous synchronization and returns the QueuedWorkItem for callers ability to handle completion event or wait
Remarks
May throw a OperationCanceledException if the sync is canceled by a susbcriber of the SynchronizationStarting cancelable event
|
| SynchronizeAsync(Boolean) |
Starts a new asyncrhonous synchronization and returns the QueuedWorkItem for callers ability to handle completion event or wait
Remarks
May throw a OperationCanceledException if the sync is canceled by a susbcriber of the SynchronizationStarting cancelable event
|
| SynchronizeAsync(Boolean, ThreadPriority) |
Starts a new asyncrhonous synchronization and returns the QueuedWorkItem for callers ability to handle completion event or wait
Remarks
May throw a OperationCanceledException if the sync is canceled by a susbcriber of the SynchronizationStarting cancelable event
|
| TableUpdated |
Event raise after data has been updated on a client table
|
| ToString()()() | (Inherited from Object.) |
| UnpackageToClient(Guid, String) |
Peforms the UnpackageToClient phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| UnpackageToServer(Guid) |
Peforms the UnpackageToServer phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| UploaderOwner |
Indicates as a string the SynchronizationClient (or external application) that owns the Uploader mutex
|
| UploadPackage(Guid) |
Peforms the UploadPackage phase of a sync
Remarks
Low-level method, Synchronize or SynchronizeAsync implements the functionallity required in nearlny all scenarios
|
| UserName |
The UserName used to authenicate the synchronization.
Remarks
If username changes, the database is resynchronized entirely.
|
| UserNameWithoutDomain |
UserName without domain name
|
Inheritance Hierarchy| Object | |
 | SynchronizationClient |