ITeamFoundationHostManagementService Interface

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

Syntax

'Declaration
<DefaultServiceImplementationAttribute(GetType(TeamFoundationHostManagementService))> _
Public Interface ITeamFoundationHostManagementService _
    Inherits ITeamFoundationService
[DefaultServiceImplementationAttribute(typeof(TeamFoundationHostManagementService))]
public interface ITeamFoundationHostManagementService : ITeamFoundationService
[DefaultServiceImplementationAttribute(typeof(TeamFoundationHostManagementService))]
public interface class ITeamFoundationHostManagementService : ITeamFoundationService
[<DefaultServiceImplementationAttribute(typeof(TeamFoundationHostManagementService))>]
type ITeamFoundationHostManagementService =  
    interface 
        interface ITeamFoundationService 
    end
public interface ITeamFoundationHostManagementService extends ITeamFoundationService

The ITeamFoundationHostManagementService type exposes the following members.

Properties

  Name Description
Public property DeploymentType Indicates where the deployment type is OnPremises, DevFabric, Cloud, or Unknown.
Public property HostDormancySeconds The minimum number of seconds a host has to go without end-user requests before background jobs start to be disabled for dormancy.
Public property IsHosted Indicates whether the DeploymentType is Cloud or DevFabric.

Top

Methods

  Name Description
Public method BeginRequest Returns a RequestContextBase targeted at the given instance
Public method BeginUserRequest
Public method CreateServiceHost Creates a service host definition using the provided properties.
Public method DeleteServiceHost(TeamFoundationRequestContext, Guid) Deletes a service host from the server.
Public method DeleteServiceHost(TeamFoundationRequestContext, Guid, UnusedDatabaseReasonNotUsed)
Public method DetectInactiveProcesses Detects and removes inactive processes (processes whose lease has expired and haven't shut down cleanly).
Public method GetConfigDataTierTime
Public method GetHostIdFromPath
Public method PingHostProcess PingHostProcess 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 method QueryChildrenServiceHostPropertiesCached
Public method QueryExecutionState(TeamFoundationRequestContext) Queries for all registered service hosts, processes and host instances.
Public method QueryExecutionState(TeamFoundationRequestContext, Guid) Queries for one or all registered service hosts, and related processes and host instances.
Public method QueryHostReadyState Queries the host ready state.
Public method QueryServiceHostProperties(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 method QueryServiceHostProperties(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 method QueryServiceHostPropertiesCached
Public method ServiceEnd ServiceEnd is called when the Host is being Shutdown and this service should free all resources it is holding onto. (Inherited from ITeamFoundationService.)
Public method ServiceStart ServiceStart 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 method StartHost
Public method Stop
Public method StopHost Synchronously stops the service host in all active processes.
Public method UpdateServiceHost Updates the service host definition using the provided properties.

Top

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace