TfsMessageQueueService Class

Provides centralized management for connections to Team Foundation Server message queues.

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Client.TfsMessageQueueService

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

Syntax

'Declaration
Public NotInheritable Class TfsMessageQueueService _
    Implements IDisposable
public sealed class TfsMessageQueueService : IDisposable
public ref class TfsMessageQueueService sealed : IDisposable
[<Sealed>]
type TfsMessageQueueService =  
    class 
        interface IDisposable 
    end
public final class TfsMessageQueueService implements IDisposable

The TfsMessageQueueService type exposes the following members.

Properties

Name Description
Public property Connection Gets the associated connection.
Public property ProjectCollection Obsolete. Gets the associated project collection.
Public property ReceiveTimeout Gets the interval of time that a connection can sustain inactivity before timing out.
Public property ReconnectTimeout Gets the interval of time allowed for reconnection before the disconnected event is raised.
Public property SleepTimeout Gets the interval of time that a connection operation will sleep when an empty response is received.

Top

Methods

Name Description
Public method Close Closes all active queues and releases all associated resources.
Public method CreateQueue(Uri) Creates an object which may be used to dequeue messages from the specified queue.
Public method CreateQueue(Uri, Int32) Creates an object which may be used to dequeue messages from the specified queue.
Public method CreateQueue(Uri, Int32, TimeSpan) Creates an object which may be used to dequeue messages from the specified queue.
Public method CreateQueue(Uri, Int32, TimeSpan, Func<SoapException, Exception>) Creates an object which may be used to dequeue messages from the specified 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 ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose Closes all active queues and releases all associated resources.

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.

See Also

Reference

Microsoft.TeamFoundation.Framework.Client Namespace