Interface IServerRegistrationService
Namespace: Umbraco.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IServerRegistrationService
Properties
View SourceCurrentServerIdentity
Gets the current server identity.
Declaration
string CurrentServerIdentity { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
View SourceDeactiveServer(String)
Deactivates a server.
Declaration
void DeactiveServer(string serverIdentity)
Parameters
Type | Name | Description |
---|---|---|
System.String | serverIdentity | The server unique identity. |
DeactiveStaleServers(TimeSpan)
Deactivates stale servers.
Declaration
void DeactiveStaleServers(TimeSpan staleTimeout)
Parameters
Type | Name | Description |
---|---|---|
System.TimeSpan | staleTimeout | The time after which a server is considered stale. |
GetActiveServers(Boolean)
Return all active servers.
Declaration
IEnumerable<IServerRegistration> GetActiveServers(bool refresh = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | refresh | A value indicating whether to force-refresh the cache. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IServerRegistration> | All active servers. |
Remarks
By default this method will rely on the repository's cache, which is updated each
time the current server is touched, and the period depends on the configuration. Use the
refresh
parameter to force a cache refresh and reload active servers
from the database.
GetCurrentServerRole()
Gets the role of the current server.
Declaration
ServerRole GetCurrentServerRole()
Returns
Type | Description |
---|---|
ServerRole | The role of the current server. |
TouchServer(String, String, TimeSpan)
Touches a server to mark it as active; deactivate stale servers.
Declaration
void TouchServer(string serverAddress, string serverIdentity, TimeSpan staleTimeout)
Parameters
Type | Name | Description |
---|---|---|
System.String | serverAddress | The server URL. |
System.String | serverIdentity | The server unique identity. |
System.TimeSpan | staleTimeout | The time after which a server is considered stale. |