This documentation is archived and is not being maintained.

ITeamFoundationHostManagementService Interface

Visual Studio 2013

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

[DefaultServiceImplementationAttribute(typeof(TeamFoundationHostManagementService))]
public interface class ITeamFoundationHostManagementService : ITeamFoundationService

The ITeamFoundationHostManagementService type exposes the following members.

  NameDescription
Public propertyDeploymentTypeIndicates where the deployment type is OnPremises, DevFabric, Cloud, or Unknown.
Public propertyHostDormancySecondsThe minimum number of seconds a host has to go without end-user requests before background jobs start to be disabled for dormancy.
Public propertyIsHostedIndicates whether the DeploymentType is Cloud or DevFabric.
Top

  NameDescription
Public methodBeginRequestReturns a RequestContextBase targeted at the given instance
Public methodBeginUserRequest
Public methodCreateServiceHostCreates a service host definition using the provided properties.
Public methodDeleteServiceHost(TeamFoundationRequestContext, Guid)Deletes a service host from the server.
Public methodDeleteServiceHost(TeamFoundationRequestContext, Guid, UnusedDatabaseReasonNotUsed)
Public methodDetectInactiveProcessesDetects and removes inactive processes (processes whose lease has expired and haven't shut down cleanly).
Public methodGetConfigDataTierTime
Public methodGetHostIdFromPath
Public methodPingHostProcessPingHostProcess is used to send a ping request to a process that is operating on this application. This request is sent via a SQL notification. If the process is running correctly and SQL Notifications are being processed the ping should return successfully within a short period of time. If Notifications are being processed via polling or the process has lost connection to the database it may take longer or never complete.
Public methodQueryChildrenServiceHostPropertiesCached
Public methodQueryExecutionState(TeamFoundationRequestContext)Queries for all registered service hosts, processes and host instances.
Public methodQueryExecutionState(TeamFoundationRequestContext, Guid)Queries for one or all registered service hosts, and related processes and host instances.
Public methodQueryHostReadyStateQueries the host ready state.
Public methodQueryServiceHostProperties(TeamFoundationRequestContext, Guid)Queries for service host properties using the provided host ID. This will not return any details about this host, and it will not include any children.
Public methodQueryServiceHostProperties(TeamFoundationRequestContext, Guid, ServiceHostFilterFlags)Queries for service host properties using the provided host ID. If children are included the output list will contain properties for all child hosts of the requested service host.
Public methodQueryServiceHostPropertiesCached
Public methodServiceEndServiceEnd is called when the Host is being Shutdown and this service should free all resources it is holding onto. (Inherited from ITeamFoundationService.)
Public methodServiceStartServiceStart is called when the service is initialized. If the service is intialized asynchronously it must implement Service_Ready which is used to determine when the service is ready for users to access it. (Inherited from ITeamFoundationService.)
Public methodStartHost
Public methodStop
Public methodStopHostSynchronously stops the service host in all active processes.
Public methodUpdateServiceHostUpdates the service host definition using the provided properties.
Top
Show: