MultiPointSynchronizer Class |
Defines a multi-point synchronizer.
Inheritance HierarchyNamespace: ShellBoost.Core.Synchronization
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public class MultiPointSynchronizer : IDisposable
The MultiPointSynchronizer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MultiPointSynchronizer |
Initializes a new instance of the MultiPointSynchronizer class.
|
Properties| Name | Description | |
|---|---|---|
 | ChecksEntryIdsUnicity |
Gets or sets a value indicating whether entry ids unicity is checked.
This is set by default to help diagnostics.
|
| CompletionOnDisposeWaitTimeout |
Gets the completion-on-dispose wait timeout, in milliseconds.
|
| ContentMover |
Gets the content mover instance.
|
| EndPoints |
Gets a list of added endpoints.
|
| EventsGroupingTimeout |
Gets the events grouping timeout, in milliseconds.
|
 | FileNameEscapeHandler |
Gets or sets a custom file name escape handler.
This value must be changed before any MultiPointSynchronizer instance is used and must never be changed after that.
|
| Identifier |
Gets the identifier.
|
| IdleTasksTimeout |
Gets the idle tasks timeout, in milliseconds.
|
| IsStarted |
Gets a value indicating whether this instance is started.
|
| IsStateReadOnly |
Gets a value indicating whether the state is read-only.
|
| JobMaximumErrorCount |
Gets a job maximum error count.
|
| JobsRunning |
Gets the number of jobs running.
|
| LastJobCreationDate |
Gets or sets the last job creation date.
|
| Logger |
Gets or sets a logger instance.
|
| NoJobCreatedRunCount |
Gets or sets the number of times the job building creation pass hasn't created any job.
|
| Options |
Gets the options.
|
| StateProvider |
Gets the state provider.
|
Methods| Name | Description | |
|---|---|---|
| AddEndPoint |
Adds a endpoint.
|
 | BuildNewJobs |
Builds new jobs from the list of changes.
|
| CheckDisposed |
Checks this instance is disposed.
|
| CheckStateReadOnly |
Checks this instance's state is read-only.
|
| CompareEntriesForStateSynchronization |
Compares the specified state entries.
The two entries must have the same RelativePath property value.
|
| DeleteErroredJobs |
Deletes the errored jobs.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Dispose(Boolean) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| DoRunJobs |
Triggers jobs run.
|
| DoRunJobs(IReadOnlyListStateSyncJob, CancellationToken) |
Runs the jobs.
|
| EnsureParentCreationJob |
Ensures there is a parent creation job for this change.
|
| EscapeInvalidChar |
Converts an invalid character into a string.
|
| EscapeNameToFileName |
Converts any text into a valid file name. Note the text may escaped and/or truncated.
|
| EscapeReservedName |
Converts a text representing a reserved file name into a string.
|
| Finalize |
Finalizes an instance of the MultiPointSynchronizer class.
(Overrides ObjectFinalize.) |
| GetDefaultSyncStateProvider |
Gets the default state provider.
|
| GetEndPoint |
Gets an endpoint using its identifier.
|
| GetFileOpenShare |
Gets FileShare to use when opening a file.
The default value is FileShare.ReadWrite.
|
| GetSources |
Gets the available sources endpoints for a given path, from a given set of endpoints.
|
| GroupChange |
Groups a StateSyncChange change instance before a job is created.
|
| IsStateProviderIdle |
Determines whether the state provider is idle.
|
| IsValidEntry |
Determines whether the specified entry is valid.
|
| Log |
Logs the value at the specified trace level.
|
| NewContentMover |
Creates a new ContentMover.
|
| NewContext |
Creates a new SyncContext.
|
| NewEndPointSynchronizer |
Creates a new EndPointSynchronizer.
|
| NewEventSink |
Creates a new ISyncEventsSink.
|
| NormalizeDateTime(DateTime) |
Normalizes a date time for comparisons.
|
| NormalizeDateTime(DateTimeOffset) |
Normalizes a date time offset for comparisons.
|
| OnJobChanged |
Called when a job has changed.
|
| OnStarted |
Called when this instance has started.
|
| OnStarting |
Called when this instance is starting.
|
| OnStopped |
Called when this instance has stopped.
|
| OnStopping |
Called when this instance is stopping.
|
| RemoveEndPoint |
Removes a endpoint. It's not recommended to remove an endpoint.
|
| RunJobAsync |
Runs a job.
|
| RunJobs |
Runs the jobs.
|
| RunWhenIdle |
Runs a task when job activity is idle.
|
| Start |
Starts this instance.
|
| StartEndPoints |
Starts all endpoints.
|
| StartEndPointsEventMonitoring |
Starts all endpoints event monitoring.
|
| Stop |
Stops the specified wait timeout.
|
| StopEndPoints |
Stops all endpoints.
|
| SynchronizeStates |
Synchronizes all endpoint states.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| UnescapeFileNameToName |
Converts a file name that was possibly escaped using the EscapeNameToFileName method into text.
Note if the text was truncated, it won't be fully recovered.
|
| UpdateEndPoints |
Updates all endpoints states.
|
Events| Name | Description | |
|---|---|---|
 | JobChanged |
Occurs when a job has changed.
|
| Started |
Occurs when this instance has started.
|
| Starting |
Occurs when this instance is starting.
|
| Stopped |
Occurs when this instance has stopped.
|
| Stopping |
Occurs when this instance is stopping.
|
See Also