MessageEnumerator MessageEnumerator MessageEnumerator MessageEnumerator Class

Definição

Fornece um cursor somente de avanço para enumerar por meio de mensagens em uma fila de mensagens.Provides a forward-only cursor to enumerate through messages in a message queue.

public ref class MessageEnumerator : MarshalByRefObject, IDisposable, System::Collections::IEnumerator
public class MessageEnumerator : MarshalByRefObject, IDisposable, System.Collections.IEnumerator
type MessageEnumerator = class
    inherit MarshalByRefObject
    interface IEnumerator
    interface IDisposable
Public Class MessageEnumerator
Inherits MarshalByRefObject
Implements IDisposable, IEnumerator
Herança
MessageEnumeratorMessageEnumeratorMessageEnumeratorMessageEnumerator
Implementações

Exemplos

O exemplo a seguir obtém uma lista dinâmica de mensagens em uma fila e contagens de todas as mensagens com o Priority propriedade definida como MessagePriority.Lowest.The following example gets a dynamic list of messages in a queue and counts all messages with the Priority property set to MessagePriority.Lowest.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
   void CountLowestPriority()
   {
      
      // Holds the count of Lowest priority messages.
      UInt32 numberItems = 0;
      
      // Connect to a queue.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
      
      // Get a cursor into the messages in the queue.
      MessageEnumerator^ myEnumerator = myQueue->GetMessageEnumerator();
      
      // Specify that the messages's priority should be read.
      myQueue->MessageReadPropertyFilter->Priority = true;
      
      // Move to the next message and examine its priority.
      while ( myEnumerator->MoveNext() )
      {
         
         // Increase the count if priority is Lowest.
         if ( myEnumerator->Current->Priority == MessagePriority::Lowest )
                  numberItems++;
      }

      
      // Display final count.
      Console::WriteLine( "Lowest priority messages: {0}", numberItems );
      return;
   }

};

int main()
{
   
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;
   
   // Output the count of Lowest priority messages.
   myNewQueue->CountLowestPriority();
   return 0;
}

using System;
using System.Messaging;

namespace MyProject
{
	/// <summary>
	/// Provides a container class for the example.
	/// </summary>
	public class MyNewQueue
	{

		//**************************************************
		// Provides an entry point into the application.
		//		 
		// This example uses a cursor to step through the
		// messages in a queue and counts the number of 
		// Lowest priority messages.
		//**************************************************

		public static void Main()
		{
			// Create a new instance of the class.
			MyNewQueue myNewQueue = new MyNewQueue();

			// Output the count of Lowest priority messages.
			myNewQueue.CountLowestPriority();
						
			return;
		}


		//**************************************************
		// Iterates through messages in a queue and examines
		// their priority.
		//**************************************************
		
		public void CountLowestPriority()
		{
			// Holds the count of Lowest priority messages.
			uint numberItems = 0;

			// Connect to a queue.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");
	
			// Get a cursor into the messages in the queue.
			MessageEnumerator myEnumerator = 
				myQueue.GetMessageEnumerator();

			// Specify that the messages's priority should be read.
			myQueue.MessageReadPropertyFilter.Priority = true;

			// Move to the next message and examine its priority.
			while(myEnumerator.MoveNext())
			{
				// Increase the count if priority is Lowest.
				if(myEnumerator.Current.Priority == 
					MessagePriority.Lowest)
					
					numberItems++;
			}

			// Display final count.
			Console.WriteLine("Lowest priority messages: " + 
				numberItems.ToString());
			
			return;
		}
	}
}
Imports System
Imports System.Messaging

Public Class MyNewQueue


        
        ' Provides an entry point into the application.
        '		 
        ' This example uses a cursor to step through the
        ' messages in a queue and counts the number of 
        ' Lowest priority messages.
        

        Public Shared Sub Main()

            ' Create a new instance of the class.
            Dim myNewQueue As New MyNewQueue()

            ' Output the count of Lowest priority messages.
            myNewQueue.CountLowestPriority()

            Return

        End Sub 'Main


        
        ' Iterates through messages in a queue and examines
        ' their priority.
        

        Public Sub CountLowestPriority()

            ' Holds the count of Lowest priority messages.
            Dim numberItems As Int32 = 0

            ' Connect to a queue.
            Dim myQueue As New MessageQueue(".\myQueue")

            ' Get a cursor into the messages in the queue.
            Dim myEnumerator As MessageEnumerator = _
                myQueue.GetMessageEnumerator()

            ' Specify that the messages's priority should be read.
            myQueue.MessageReadPropertyFilter.Priority = True

            ' Move to the next message and examine its priority.
            While myEnumerator.MoveNext()

                ' Increase the count if the priority is Lowest.
                If myEnumerator.Current.Priority = _
                    MessagePriority.Lowest Then
                    numberItems += 1
                End If

            End While

            ' Display final count.
            Console.WriteLine(("Lowest priority messages: " + _
                numberItems.ToString()))

            Return

        End Sub 'CountLowestPriority

End Class 'MyNewQueue

Comentários

Use MessageEnumerator para interação dinâmica com mensagens em uma fila.Use MessageEnumerator for dynamic interaction with messages in a queue. Métodos disponíveis por meio de MessageQueue classe pode retornar um MessageEnumerator que aponta para uma lista dinâmica de mensagens na fila ou uma matriz que contém uma cópia em um dado momento – um instantâneo - da fila no momento, o método especificado foi chamado.Methods available through the MessageQueue class can return either a MessageEnumerator pointing to a dynamic list of messages in the queue, or an array that contains a copy at a given instant - a snapshot - of the queue at the time the specified method was called.

Ao contrário de um instantâneo estático, um enumerador permite modificar a coleção.Unlike a static snapshot, an enumerator allows you to modify the collection. Usando um MessageEnumerator, você pode remover mensagens da fila e a alteração é refletida imediatamente na fila.Using a MessageEnumerator, you can remove messages from the queue, and the change is immediately reflected in the queue.

Um enumerador não remove as mensagens da fila quando ele consulta a fila.An enumerator does not remove the messages from the queue when it queries the queue. Ele retorna informações sobre a mensagem na posição atual do cursor, mas deixa a mensagem na fila.It returns information about the message at the current cursor position, but it leaves the message in the queue.

Um MessageEnumerator é um cursor, inicializado para o início de uma lista dinâmica.A MessageEnumerator is a cursor, initialized to the head of a dynamic list. A ordem da lista é igual à ordem das mensagens na fila, de acordo com a prioridade da mensagem.The list order is the same as the order of the messages in the queue, according to message priority. Você pode mover o cursor para a primeira mensagem na fila chamando MoveNext.You can move the cursor to the first message in the queue by calling MoveNext. Depois que o enumerador foi inicializado, você pode usar MoveNext para percorrer as mensagens restantes para frente.After the enumerator has been initialized, you can use MoveNext to step forward through the remaining messages. Você pode especificar se deseja esperar uma mensagem se torne disponível, passando um tempo limite para o MoveNext método.You can specify whether to wait for a message to become available by passing a timeout into the MoveNext method.

Como o enumerador é dinâmico, uma mensagem que é acrescentada a posição do cursor atual (por exemplo, devido à baixa prioridade), além do pode ser acessado pelo enumerador.Because the enumerator is dynamic, a message that is appended beyond the cursor's current position (for example, due to low priority), can be accessed by the enumerator. Uma mensagem que é inserida antes que a posição do cursor atual não pode ser acessada.A message that is inserted before the cursor's current position cannot be accessed. Não é possível retroceder uma etapa com um MessageEnumerator.It is not possible to step backward with a MessageEnumerator. Um cursor permite a movimentação de somente avanço.A cursor allows forward-only movement. O Reset método permite que você coloque o cursor novamente no início da fila.The Reset method enables you to place the cursor back at the beginning of the queue.

Instâncias de MessageEnumerator para uma determinada fila trabalhar de forma independente.Instances of MessageEnumerator for a given queue work independently. Você pode criar dois MessageEnumerator instâncias que se aplicam à mesma fila.You can create two MessageEnumerator instances that apply to the same queue. As alterações que um MessageEnumerator facilita para as mensagens na fila serão refletidas imediatamente no enumerador segundo se o segundo enumerador está posicionado antes da primeira.The changes that one MessageEnumerator makes to the messages in the queue will be reflected immediately in a second enumerator if the second enumerator is positioned before the first. No entanto, se dois enumeradores têm a mesma posição e um deles remove a mensagem nessa posição, uma exceção é lançada se o enumerador outro tentativas de obter o valor da Current propriedade na mensagem excluída por enquanto.However, if two enumerators have the same position and one of them removes the message at that position, an exception is thrown if the other enumerator attempts to get the value of the Current property on the now-deleted message.

Observação

Se você criar uma instância do MessageQueue com MessageQueue.DenySharedReceive definido como true, nenhum outro aplicativo pode modificar as mensagens no seu enumerador enquanto você tem a conexão para a fila.If you create an instance of MessageQueue with MessageQueue.DenySharedReceive set to true, no other application can modify the messages in your enumerator while you have the connection to the queue.

Propriedades

Current Current Current Current

Obtém o Message atual para o qual este enumerador aponta.Gets the current Message that this enumerator points to.

CursorHandle CursorHandle CursorHandle CursorHandle

Obtém o cursor de Enfileiramento de Mensagens nativo usado para procurar mensagens na fila.Gets the native Message Queuing cursor handle used to browse messages in the queue.

Métodos

Close() Close() Close() Close()

Libera os recursos associados ao enumerador.Frees the resources associated with the enumerator.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

Libera todos os recursos usados pelo MessageEnumerator.Releases all resources used by the MessageEnumerator.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Libera os recursos não gerenciados usados pelo MessageEnumerator e opcionalmente libera os recursos gerenciados.Releases the unmanaged resources used by the MessageEnumerator and optionally releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize() Finalize() Finalize() Finalize()

Libera os recursos mantidos pelo enumerador.Releases the resources held by the enumerator.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetType() GetType() GetType() GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
MoveNext() MoveNext() MoveNext() MoveNext()

Avança o enumerador para a próxima mensagem na fila, se houver um disponível no momento.Advances the enumerator to the next message in the queue, if one is currently available.

MoveNext(TimeSpan) MoveNext(TimeSpan) MoveNext(TimeSpan) MoveNext(TimeSpan)

Avança o enumerador para a próxima mensagem na fila.Advances the enumerator to the next message in the queue. Se o enumerador estiver posicionado no final da fila, o MoveNext() aguardará até uma mensagem estar disponível ou o tempo limite determinado ser atingido.If the enumerator is positioned at the end of the queue, MoveNext() waits until a message is available or the given timeout expires.

RemoveCurrent() RemoveCurrent() RemoveCurrent() RemoveCurrent()

Remove a mensagem atual de uma fila transacional ou não transacional e retorna a mensagem para o aplicativo de chamada.Removes the current message from a transactional or non-transactional queue and returns the message to the calling application. Não há nenhum tempo limite especificado para uma mensagem chegar na fila.There is no timeout specified for a message to arrive in the queue.

RemoveCurrent(MessageQueueTransaction) RemoveCurrent(MessageQueueTransaction) RemoveCurrent(MessageQueueTransaction) RemoveCurrent(MessageQueueTransaction)

Remove a mensagem atual de uma fila transacional e retorna a mensagem ao aplicativo de chamada.Removes the current message from a transactional queue and returns the message to the calling application. Não há nenhum tempo limite especificado para uma mensagem chegar na fila.There is no timeout specified for a message to arrive in the queue.

RemoveCurrent(MessageQueueTransactionType) RemoveCurrent(MessageQueueTransactionType) RemoveCurrent(MessageQueueTransactionType) RemoveCurrent(MessageQueueTransactionType)

Remove a mensagem atual de uma fila e retorna a mensagem ao aplicativo de chamada.Removes the current message from a queue and returns the message to the calling application. Não há nenhum tempo limite especificado para uma mensagem chegar na fila.There is no timeout specified for a message to arrive in the queue.

RemoveCurrent(TimeSpan) RemoveCurrent(TimeSpan) RemoveCurrent(TimeSpan) RemoveCurrent(TimeSpan)

Remove a mensagem atual da fila e retorna a mensagem para o aplicativo de chamada.Removes the current message from the queue and returns the message to the calling application. Se houver uma mensagem a ser removida, o método a retornará imediatamente.If there is a message to remove, the method returns it immediately. Caso contrário, o método aguardará o tempo limite especificado para que uma nova mensagem chegue.Otherwise, the method waits the specified timeout for a new message to arrive.

RemoveCurrent(TimeSpan, MessageQueueTransaction) RemoveCurrent(TimeSpan, MessageQueueTransaction) RemoveCurrent(TimeSpan, MessageQueueTransaction) RemoveCurrent(TimeSpan, MessageQueueTransaction)

Remove a mensagem atual de uma fila transacional e retorna a mensagem ao aplicativo de chamada.Removes the current message from a transactional queue and returns the message to the calling application. Se houver uma mensagem a ser removida, o método a retornará imediatamente.If there is a message to remove, the method returns it immediately. Caso contrário, o método aguardará o tempo limite especificado para que uma nova mensagem chegue.Otherwise, the method waits the specified timeout for a new message to arrive.

RemoveCurrent(TimeSpan, MessageQueueTransactionType) RemoveCurrent(TimeSpan, MessageQueueTransactionType) RemoveCurrent(TimeSpan, MessageQueueTransactionType) RemoveCurrent(TimeSpan, MessageQueueTransactionType)

Remove a mensagem atual de uma fila e retorna a mensagem ao aplicativo de chamada.Removes the current message from a queue and returns the message to the calling application. Se houver uma mensagem a ser removida, o método a retornará imediatamente.If there is a message to remove, the method returns it immediately. Caso contrário, o método aguardará o tempo limite especificado para que uma nova mensagem chegue.Otherwise, the method waits the specified timeout for a new message to arrive.

Reset() Reset() Reset() Reset()

Redefine o enumerador atual para que ele aponte para o início da fila.Resets the current enumerator so it points to the head of the queue.

ToString() ToString() ToString() ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Inherited from Object)

Implantações explícitas de interface

IEnumerator.Current IEnumerator.Current IEnumerator.Current IEnumerator.Current

Retorna um Message que faz referência à mensagem na posição atual do cursor.Returns a Message that references the message at the current cursor position.

Aplica-se a

Veja também