TeamFoundationServiceHost Class
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.Framework.Server.ServiceHost<TeamFoundationRequestContext>
Microsoft.TeamFoundation.Framework.Server.TeamFoundationServiceHost
Microsoft.TeamFoundation.Framework.Server.DeploymentServiceHost
Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)
Syntax
'Declaration
Public Class TeamFoundationServiceHost _
Inherits ServiceHost(Of TeamFoundationRequestContext) _
Implements IDisposable
public class TeamFoundationServiceHost : ServiceHost<TeamFoundationRequestContext>,
IDisposable
public ref class TeamFoundationServiceHost : public ServiceHost<TeamFoundationRequestContext^>,
IDisposable
type TeamFoundationServiceHost =
class
inherit ServiceHost<TeamFoundationRequestContext>
interface IDisposable
end
public class TeamFoundationServiceHost extends ServiceHost<TeamFoundationRequestContext> implements IDisposable
The TeamFoundationServiceHost type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
ActiveRequests | List of active requests on this host (Inherited from ServiceHost<T>.) |
.gif "Public property") |
ApplicationServiceHost | Retrieves the application service host from the current host, if this host is an application or collection.If it is a DeploymentServiceHost this property will return null. |
|
Authority | Returns the authority of the host (e.g. contoso.tfs.com). This can be null if the host does not require authority-matching for host selection. |
|
CollectionServiceHost | Retrieves the collection service host from the current host. If this host is not a collection it will search up the host chain to find it. If one isnt found, it will return null. |
|
DataDirectory | This the fully qualified local filesystem directory that this host can used to store files. Other hosts will not read/write to this location. An example of this is the VersionControl Proxy cache location. Gets the data directory configured based on the following logic: 1. Checks to see whether there is one specified in the .config file. 2. Checks to see whether there is one specified in the registry. 3. Use the PhysicalDirectory\_tfs_data if it is available. 4. String.Empty is used as the root. The directory is then made unique for this host.The directory is then made unique for this host. |
|
DeploymentServiceHost | Retrieves the deployment service host associated with the current host. For Deployment, Application and Collection hosts this should never return null. |
|
HasDatabaseAccess | Returns true if the service host knows how to talk to the database |
|
HostType | The context this service host is running in. |
|
InstanceId | The unique identifier for this service host. (Overrides ServiceHost<T>.InstanceId.) |
|
IsDisposed | (Inherited from ServiceHost<T>.) |
|
IsProduction | Flag that determines Production/Development Environment. |
|
Items | The Items collection allows for others in the system to store named data in the context of a single service host. |
|
LastUse | (Inherited from ServiceHost<T>.) |
|
Metabase | The MetaBase for this host defines is general configuration around its path structure. |
|
MetabaseRegistryPatterns | The metabase registry query patterns for this service host. |
|
Name | The name for this service host. May be null or empty. |
|
NumberOfActiveRequests | Number of currently active requests (Inherited from ServiceHost<T>.) |
|
ParentServiceHost | |
|
PartitionId | |
|
PhysicalDirectory | This is the fully qualified local file system directory that this host is mapped to. If the virtual path is remapped, this directory should represent the remapped location. |
|
PlugInDirectory | |
|
RequestsDrainedEvent | Gets the Event. (Inherited from ServiceHost<T>.) |
|
StartTime | Gets the time this host instance was started. |
|
StaticContentDirectory | The static content directory, relative to the SAP. This allows the virtual directory to be mapped to a different location than the actual content on the drive. |
|
Status | Gets the current status of the service host. |
|
StatusReason | Gets the reason for the current status. |
|
VirtualDirectory | This is the virtual directory of the host, relative to the SAP Example: http://charry-dev:8080/Application/Collection Application Host = /Application Collection Host = /Application/Colletion (Overrides ServiceHost<T>.VirtualDirectory.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ApplicationEndRequest | End an application request. Processes request filters, removes the request from the set of active requests, and disposes the request context. |
|
BeginRequest | Add a request context to the set of currently active requests (Overrides ServiceHost<T>.BeginRequest(T).) |
.gif "Protected method") |
BeginStatusChange | Begins a status change operation on the current host if applicable. |
|
CheckIfDisposed | Verify the host is still a valid host object and hasn't been disposed before we start using it. (Inherited from ServiceHost<T>.) |
|
CreateServicingContext | |
|
Dispose() | (Inherited from ServiceHost<T>.) |
|
Dispose(Boolean) | (Overrides ServiceHost<T>.Dispose(Boolean).) |
|
EndRequest | Remove a request context to the set of currently active requests (Overrides ServiceHost<T>.EndRequest(T).) |
|
EndStatusChange | Completes a status change operation by transitioning the state to the next valid state. Stopping goes to Stopped, Starting goes to Started, and Pausing goes to Paused. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetCulture | The Application Culture is the installed culture for this team foundation application. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
InitializeMetabaseLegacy | Initialize the metabase the old way. We still need to keep this method to support online upgrade, when the request restriction registry keys are not yet persisted to the TFS registry table. Note: DO NOT add new request restrictions to this method. |
|
Is | Is can be used to determine whether a service host supports the features of a given TeamFoundationHostType. One service host can support multiple host types. |
|
IsOnly | ServiceHosts can be multiple types at the same time, an example is the deployment service host may be combined with an application service host. This method will make sure that the host is only the type specified and not combined with other types. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MonitorClientDisconnects | |
|
MonitorServiceHostRequests | |
|
OiHeartbeat | |
|
RaisePropertiesChanged | |
|
RaiseStatusChanged | |
|
ReportException | |
|
SetHostStatus | This method is for internal use only. |
|
StartServices | Loads the core services in the appropriate order. |
|
StopServices | Shuts down all active services for the current service host. |
|
ThrowIfShutdown | Throws an exception if the host is currently paused or stopped. |
|
ToString() | (Overrides Object.ToString().) |
.gif "Static member") |
ToString(Guid, String) | |
|
ToString(String, String) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertiesChanged | Provide events to capture the host properties changing. |
|
StatusChanged | Provide events to capture the host status changing and changed events. |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
m_hostProperties | |
|
m_hostPropertiesLock | |
|
s_hostSecurityNamespace |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.