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)

'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.

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

Top

	Name	Description
	Abort	Aborts the message queue connection and immediately returns control to the caller.
	BeginClose(AsyncCallback, Object)
	BeginClose(TimeSpan, AsyncCallback, Object)
	BeginDequeue	Begins an asynchronous operation to dequeue a message from the queue.
	Close()	Closes the message queue and releases any listeners which are waiting to dequeue a message.
	Close(TimeSpan)
	Dequeue(TimeSpan)	Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
	Dequeue(TimeSpan, TfsDequeueContext%)	Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.
	EndClose
	EndDequeue(IAsyncResult)	Ends an asynchronous operation to dequeue a message from the queue.
	EndDequeue(IAsyncResult, TfsDequeueContext%)	Ends an asynchronous operation to dequeue a message from the queue.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

	Name	Description
	Connected	Raised when the message queue establishes a successful connection to the server.
	Disconnected	Raised 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.