WebSyncHelper MembersKentico 8.1 API Reference
The WebSyncHelper type exposes the following members.
Constructors

  NameDescription
Public methodWebSyncHelper
Back to Top
Methods

  NameDescription
Public methodStatic memberClear
Clears the hashtables of web farm servers.
Public methodStatic memberCreateTask
Creates task.
Public methodStatic memberDeleteDynamicServer
Deletes the dynamic web farm server
Public methodStatic memberDeleteMemorySynchronizationTasks
Deletes memory synchronization web farm tasks.
Public methodStatic memberDeleteTask
Removes task for specified server.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodStatic memberGetAllEnabledServersObsolete.
Returns the DataSet of all the enabled servers records.
Public methodStatic memberGetAzureWebFarmName
Constructs the name for web farms when running on Azure.
Public methodStatic memberGetEnabledServerNamesObsolete.
Gets the list of currently enabled server names.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodStatic memberGetNotificationPath
Gets default notification path for given server physical path
Public methodStatic memberGetServerTasks
Returns dataset with tasks to current server.
Public methodStatic memberGetTaskBinaryData
Returns task binary data.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodStatic memberGetWebFarmUpdater
Returns web farm updater instance.
Public methodStatic memberInitWebFarm
Initializes the web farm environment
Public methodStatic memberIsFileSynchronizationAllowed
Returns value which indicates whether current file is allowed to web farm synchronization.
Public methodStatic memberIsServerEnabledObsolete.
Returns true if the server with given ID is enabled
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodStatic memberNotifyServer(Int32)
Notifies a web farm server about a new task.
Public methodStatic memberNotifyServer(String)
Notifies a web farm server about a new task.
Public methodStatic memberNotifyServers
Notifies other servers that some changes occured
Public methodStatic memberProcessMyTasks
Reads all tasks assigned to the current server and processes them. It processes only tasks for the server with code name stored in the CMSWebFarmServerName web.config variable.
Public methodStatic memberProcessTask
Processes the specified task and deletes it.
Public methodStatic memberRegisterWatchers
Initializes file system watchers
Public methodStatic memberRegisterWebFarmMemoryTask
Registers the given task as the memory only task
Public methodStatic memberSetErrorInTask
Sets the error message to the specified task.
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberNOTIFY_FILENAME
File name of the file for web farm server notification
Back to Top
Properties

  NameDescription
Public propertyStatic memberCurrentlyDeletedServerID
Gets or sets the ID of the currently deleted server.
Public propertyStatic memberDeleteGeneratedWebFarmServers
Specifies whether generated web farm servers are deleted automatically on application end.
Public propertyStatic memberEnabledServers
Gets the collection of enabled servers.
Public propertyStatic memberGenerateWebFarmServers
Specifies whether web farm servers are generated automatically on first application start.
Public propertyStatic memberInstanceIsHiddenWebFarmServer
Indicates that the instance is hidden part of the web farm.
Public propertyStatic memberMaxWebFarmFileSize
Gets the maximal file size which is allowed for web farm synchronization.
Public propertyStatic memberNotifyPath
Physical path to the watcher folder for web farm server notification.
Public propertyStatic memberNotifyWatcher
File watcher to notify web farm server to process tasks.
Public propertyStatic memberScriptTimeout
Gets or sets the script timeout in seconds.
Public propertyStatic memberServerCount
Returns count of enabled web farm servers.
Public propertyStatic memberServerId
Server ID.
Public propertyStatic memberServerName
Server name.
Public propertyStatic memberServersToUpdate
Gets the collection of servers to be updated if needed. Current server is excluded.
Public propertyStatic memberSynchronizeDeleteFiles
Gets or sets value that indicates whether file delete synchronization is enabled.
Public propertyStatic memberSynchronizeFiles
Gets or sets value that indicates whether file synchronization is enabled.
Public propertyStatic memberTeamDevelopmentEnabled
Gets a value that specifies whether the team development is enabled.
Public propertyStatic memberUpdateWebFarmWithinRequest
Gets or sets the value that indicates whether web farm updater should be called within current request.
Public propertyStatic memberUseDbWebFarmUpdater
Returns whether database web farm updater is used.
Public propertyStatic memberUseTasksForExternalApplication
Indicates if synchronization tasks should be logged and processed for external applications.
Public propertyStatic memberWebFarmEnabled
Gets or sets the value that indicates whether web farm for current server is enabled. Set value overrides only web config enable setting.
Public propertyStatic memberWebFarmInstanceEnabled
Gets the value that indicates whether webfarm instance is enabled in configuration file
Public propertyStatic memberWebFarmMemoryTasks
Gets list of all task types which synchronizes only memory objects.
Public propertyStatic memberWebFarmReady
Returns whether are web farms ready.
Public propertyStatic memberWebFarmUpdaterClass
Web farm updater class used to update web farm servers.
Public propertyStatic memberWebFarmUpdaterPage
Gets or sets the web farm updater page location. Default page location: "/CMSPages/webfarmupdater.aspx"
Back to Top
Events

  NameDescription
Public eventStatic memberOnProcessCustomTask
Custom task event.
Back to Top
See Also