TeamFoundationMessageQueueService Class

  • Article

Manages message queues for a Team Foundation Server Project Collection.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.TeamFoundationMessageQueueService

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

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationRegistryService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationEventService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationTaskService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationHostManagementService))> _
Public NotInheritable Class TeamFoundationMessageQueueService _
    Implements ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationEventService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))]
public sealed class TeamFoundationMessageQueueService : ITeamFoundationService

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationEventService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))]
public ref class TeamFoundationMessageQueueService sealed : ITeamFoundationService

[<Sealed>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationEventService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationTaskService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationHostManagementService))>]
type TeamFoundationMessageQueueService =  
    class 
        interface ITeamFoundationService 
    end

public final class TeamFoundationMessageQueueService implements ITeamFoundationService

The TeamFoundationMessageQueueService type exposes the following members.

Constructors

  Name Description
Public method TeamFoundationMessageQueueService

Top

Properties

  Name Description
Public property IdleTimeout Gets the interval of time a connection to a message queue can remain connected in an idle state before it is released.
Public property OfflineTimeout Gets the interval of time allowed between client connections before a message queue is considered to be offline.

Top

Methods

  Name Description
Public method BeginAcknowledge(TeamFoundationRequestContext, String, Guid, IList<AcknowledgementRange>, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation which acknowledges all messages which are inclusive to the ranges provided.
Public method BeginAcknowledge(TeamFoundationRequestContext, String, Guid, IList<AcknowledgementRange>, MessageHeaders, TimeSpan, AsyncCallback, Object) Begins an asynchronous operation which acknowledges all messages which are inclusive to the ranges provided.
Public method BeginDequeue(TeamFoundationRequestContext, String, Guid, Int64, IList<AcknowledgementRange>, TimeSpan, AsyncCallback, Object) Begins an asynchronous dequeue operation on a message queue.
Public method BeginDequeue(TeamFoundationRequestContext, String, Guid, Int64, IList<AcknowledgementRange>, MessageHeaders, TimeSpan, AsyncCallback, Object) Begins an asynchronous dequeue operation on a message queue.
Public method CreateQueue Creates a new message queue.
Public method DeleteQueue
Public method EmptyQueue Empties the contents of the message queue by marking any outstanding messages acknowledged.
Public method EndAcknowledge Ends an asynchronous acknowledge operation on a message queue.
Public method EndDequeue Ends an asynchronous dequeue operation on a message queue.
Public method EnqueueMessage Enqueues a message into a message queue.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method QueueExists Determines whether or not the specified queue is registered.
Public method SetQueueOffline Sets the message queue status for queueName to offline.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceEnd This method is provided for integration into the Team Foundation Server OM. Do not call directly from user code.
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceStart This method is provided for integration into the Team Foundation Server OM. Do not call directly from user code.

Top

Remarks

Location Service Identifier: F93895D3-984C-453E-B16E-BBF147526C9D

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.

See Also

Reference

Microsoft.TeamFoundation.Framework.Server Namespace