This documentation is archived and is not being maintained.

TfsMessageQueue Class

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

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

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

public sealed class TfsMessageQueue

The TfsMessageQueue type exposes the following members.

  NameDescription
Public propertyIdGets the unique identifier for this queue.
Public propertyMaxAcknowledgementDelayGets the maximum time to delay acknowledgement of messages on the server.
Public propertyMaxPendingCountGets the maximum number of messages which can be dequeued at the same time.
Top

  NameDescription
Public methodAbortAborts the message queue connection and immediately returns control to the caller.
Public methodBeginClose(AsyncCallback, Object)
Public methodBeginClose(TimeSpan, AsyncCallback, Object)
Public methodBeginDequeueBegins an asynchronous operation to dequeue a message from the queue.
Public methodClose()Closes the message queue and releases any listeners which are waiting to dequeue a message.
Public methodClose(TimeSpan)
Public methodDequeue(TimeSpan)Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
Public methodDequeue(TimeSpan, TfsDequeueContext)Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
Public methodEndClose
Public methodEndDequeue(IAsyncResult)Ends an asynchronous operation to dequeue a message from the queue.
Public methodEndDequeue(IAsyncResult, TfsDequeueContext)Ends an asynchronous operation to dequeue a message from the queue.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventConnectedRaised when the message queue establishes a successful connection to the server.
Public eventDisconnectedRaised when the message queue first notices a disruption in connectivity to the server.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: