Share via


TfsMessageQueue Class

Provides access to a message queue hosted on a Team Foundation Server.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Client.TfsMessageQueue

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

Syntax

'Declaration
Public NotInheritable Class TfsMessageQueue
public sealed class TfsMessageQueue
public ref class TfsMessageQueue sealed
[<Sealed>]
type TfsMessageQueue =  class end
public final class TfsMessageQueue

The TfsMessageQueue type exposes the following members.

Properties

  Name Description
Public property AdditionalHeaders
Public property Id Gets the unique identifier for this queue.
Public property MaxAcknowledgementDelay Gets the maximum time to delay acknowledgement of messages on the server.
Public property MaxPendingCount Gets the maximum number of messages which can be dequeued at the same time.

Top

Methods

  Name Description
Public method Abort
Public method BeginClose(AsyncCallback, Object)
Public method BeginClose(TimeSpan, AsyncCallback, Object)
Public method BeginDequeue Begins an asynchronous operation to dequeue a message from the queue.
Public method Close() Closes the message queue and releases any listeners which are waiting to dequeue a message.
Public method Close(TimeSpan)
Public method Dequeue(TimeSpan) Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
Public method Dequeue(TimeSpan, TfsDequeueContext%) Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
Public method EndClose
Public method EndDequeue(IAsyncResult) Ends an asynchronous operation to dequeue a message from the queue.
Public method EndDequeue(IAsyncResult, TfsDequeueContext%) Ends an asynchronous operation to dequeue a message from the queue.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (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

Events

  Name Description
Public event Connected Raised when the message queue establishes a successful connection to the server.
Public event Disconnected Raised when the message queue first notices a disruption in connectivity to the server.

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