MessageQueue.PeekByCorrelationId Metodo

Definizione

Spazio dei nomi:

System.Messaging

Assembly:

System.Messaging.dll

Legge un messaggio che corrisponde a un determinato identificatore di correlazione.

Overload

PeekByCorrelationId(String)	Legge il messaggio che corrisponde all'identificatore di correlazione specificato e, se nella coda non è disponibile correntemente alcun messaggio con l'identificatore di correlazione specificato, genererà immediatamente un'eccezione.
PeekByCorrelationId(String, TimeSpan)	Legge il messaggio che corrisponde all'identificatore di correlazione specificato e attende che un messaggio con l'identificatore di correlazione specificato sia disponibile nella coda o che il timeout scada.

PeekByCorrelationId(String)

Legge il messaggio che corrisponde all'identificatore di correlazione specificato e, se nella coda non è disponibile correntemente alcun messaggio con l'identificatore di correlazione specificato, genererà immediatamente un'eccezione.

public System.Messaging.Message PeekByCorrelationId (string correlationId);

Parametri

correlationId

String

Oggetto CorrelationId del messaggio da leggere.

Restituisce

Message

Message il cui CorrelationId corrisponde al parametro correlationId trasmesso.

Eccezioni

ArgumentNullException

Il valore del parametro correlationId è null.

InvalidOperationException

Impossibile trovare il messaggio con il parametro correlationId specificato.

MessageQueueException

Si è verificato un errore durante l'accesso a un metodo di Accodamento messaggi.

Esempio

Nell'esempio di codice seguente viene inviato e ricevuto un messaggio contenente un ordine da e verso una coda. Richiede in particolare un riconoscimento positivo quando il messaggio originale raggiunge o viene recuperato dalla coda.

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 sends and receives a message from
        // a queue.
        //**************************************************

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

            // Create new queues.
            CreateQueue(".\\myQueue");
            CreateQueue(".\\myAdministrationQueue");

            // Send messages to a queue.
            myNewQueue.SendMessage();

            // Receive messages from a queue.
            string messageId = myNewQueue.ReceiveMessage();

            // Receive acknowledgment message.
            if(messageId != null)
            {
                myNewQueue.ReceiveAcknowledgment(messageId, ".\\myAdministrationQueue");
            }

            return;
        }

        //**************************************************
        // Creates a new queue.
        //**************************************************

        public static void CreateQueue(string queuePath)
        {
            try	
            {
                if(!MessageQueue.Exists(queuePath))
                {
                    MessageQueue.Create(queuePath);
                }
                else
                {
                    Console.WriteLine(queuePath + " already exists.");
                }
            }
            catch (MessageQueueException e)
            {
                Console.WriteLine(e.Message);
            }
        }

        //**************************************************
        // Sends a string message to a queue.
        //**************************************************
        
        public void SendMessage()
        {

            // Connect to a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            // Create a new message.
            Message myMessage = new Message("Original Message");

            myMessage.AdministrationQueue = new MessageQueue(".\\myAdministrationQueue");
            myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive | AcknowledgeTypes.PositiveArrival;

            // Send the Order to the queue.
            myQueue.Send(myMessage);

            return;
        }

        //**************************************************
        // Receives a message containing an Order.
        //**************************************************
        
        public  string ReceiveMessage()
        {
            // Connect to the a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            myQueue.MessageReadPropertyFilter.CorrelationId = true;

            // Set the formatter to indicate body contains an Order.
            myQueue.Formatter = new XmlMessageFormatter(new Type[]
                {typeof(string)});

            string returnString = null;
            
            try
            {
                // Receive and format the message.
                Message myMessage =	myQueue.Receive();

                // Display message information.
                Console.WriteLine("____________________________________________");
                Console.WriteLine("Original message information--");
                Console.WriteLine("Body: " +myMessage.Body.ToString());
                Console.WriteLine("Id: " + myMessage.Id.ToString());
                Console.WriteLine("____________________________________________");

                returnString =  myMessage.Id;
            }
            
            catch (MessageQueueException)
            {
                // Handle Message Queuing exceptions.
            }

            // Handle invalid serialization format.
            catch (InvalidOperationException e)
            {
                Console.WriteLine(e.Message);
            }
            
            // Catch other exceptions as necessary.

            return returnString;
        }

        //**************************************************
        // Receives a message containing an Order.
        //**************************************************
        
        public void ReceiveAcknowledgment(string messageId, string queuePath)
        {
            bool found = false;
            MessageQueue queue = new MessageQueue(queuePath);
            queue.MessageReadPropertyFilter.CorrelationId = true;
            queue.MessageReadPropertyFilter.Acknowledgment = true;

            try
            {
                while(queue.PeekByCorrelationId(messageId) != null)
                {
                    Message myAcknowledgmentMessage = queue.ReceiveByCorrelationId(messageId);
            
                    // Output acknowledgment message information. The correlation Id is identical
                    // to the id of the original message.
                    Console.WriteLine("Acknowledgment Message Information--");
                    Console.WriteLine("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString());
                    Console.WriteLine("Id: " + myAcknowledgmentMessage.Id.ToString());
                    Console.WriteLine("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString());
                    Console.WriteLine("____________________________________________");

                    found = true;
                }
            }
            catch (InvalidOperationException e)
            {
                // This exception would be thrown if there is no (further) acknowledgment message
                // with the specified correlation Id. Only output a message if there are no messages;
                // not if the loop has found at least one.
                if(found == false)
                {	
                    Console.WriteLine(e.Message);
                }

                // Handle other causes of invalid operation exception.
            }
        }
    }
}

Commenti

Questo metodo cerca nella coda a cui fa riferimento l'oggetto MessageQueue per un messaggio il cui CorrelationId corrisponde al parametro specificato correlationId . Se non viene trovato alcun messaggio corrispondente al correlationID parametro , viene generata un'eccezione.

La CorrelationId proprietà viene utilizzata per collegare un messaggio inviato alla coda a messaggi di risposta, report o riconoscimento associati.

Altri due metodi consentono di visualizzare i messaggi in una coda. Il Peek metodo restituisce il primo messaggio nella coda e il PeekById(String) metodo viene utilizzato per recuperare un messaggio specificando il relativo identificatore univoco.

Nella tabella seguente viene illustrato se questo metodo è disponibile in varie modalità gruppo di lavoro.

Modalità gruppo di lavoro	Disponibile
Computer locale	Sì
Computer locale e nome del formato diretto	Sì
Computer remoto	No
Nome del formato diretto e del computer remoto	Sì

Vedi anche

• CorrelationId
• Peek()
• BeginPeek()

PeekByCorrelationId(String, TimeSpan)

Legge il messaggio che corrisponde all'identificatore di correlazione specificato e attende che un messaggio con l'identificatore di correlazione specificato sia disponibile nella coda o che il timeout scada.

public System.Messaging.Message PeekByCorrelationId (string correlationId, TimeSpan timeout);

Parametri

correlationId

String

Oggetto CorrelationId del messaggio da leggere.

timeout

TimeSpan

Oggetto TimeSpan che indica l'intervallo di attesa prima che un nuovo messaggio venga reso disponibile per il controllo.

Restituisce

Message

Message il cui CorrelationId corrisponde al parametro correlationId trasmesso.

Eccezioni

ArgumentNullException

Il valore del parametro correlationId è null.

ArgumentException

Il valore specificato per il parametro timeout non è valido, probabilmente perché timeout è minore di Zero o maggiore di InfiniteTimeout.

InvalidOperationException

Il messaggio con l'oggetto correlationId specificato non è presente nella coda e non è arrivato prima della scadenza del timeout.

MessageQueueException

Un messaggio non è arrivato prima della scadenza del timeout.

-oppure-

Si è verificato un errore durante l'accesso a un metodo di Accodamento messaggi.

Esempio

L'esempio di codice seguente illustra l'uso di PeekByCorrelationId(String, TimeSpan).

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Create a new message.
Message msg = new Message("Example Message Body");

// Designate a queue to receive the acknowledgement message for this
// message.
msg.AdministrationQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the message to generate an acknowledgement message upon its
// arrival.
msg.AcknowledgeType = AcknowledgeTypes.PositiveArrival;

// Send the message.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

// Connect to the admin queue.
MessageQueue adminQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the admin queue's MessageReadPropertyFilter property to ensure
// that the acknowledgement message includes the desired properties.
adminQueue.MessageReadPropertyFilter.Acknowledgment = true;
adminQueue.MessageReadPropertyFilter.CorrelationId = true;

// Peek at the acknowledgement message.
Message ackMsg = adminQueue.PeekByCorrelationId(id,
    TimeSpan.FromSeconds(10.0));

// Display the acknowledgement message's property values.
Console.WriteLine("Message.Label: {0}", ackMsg.Label);
Console.WriteLine("Message.Acknowledgment: {0}", ackMsg.Acknowledgment);
Console.WriteLine("Message.CorrelationId: {0}", ackMsg.CorrelationId);

Commenti

Questo metodo cerca nella coda a cui fa riferimento l'oggetto MessageQueue per un messaggio il cui CorrelationId corrisponde al parametro specificato correlationId . Se non viene trovato alcun messaggio corrispondente al correlationID parametro e non viene visualizzato alcun nuovo messaggio nella coda entro il periodo specificato dal timeout parametro , viene generata un'eccezione.

Il timeout parametro non specifica il tempo di esecuzione totale per questo metodo. Specifica invece il tempo di attesa per l'arrivo di un nuovo messaggio nella coda. Ogni volta che arriva un nuovo messaggio, questo metodo esamina il CorrelationId del nuovo messaggio per verificare se corrisponde al correlationId parametro . In caso contrario, questo metodo avvia il periodo di timeout e attende l'arrivo di un altro nuovo messaggio. Pertanto, se i nuovi messaggi continuano ad arrivare entro il periodo di timeout, è possibile che questo metodo continui a essere in esecuzione per un periodo illimitato, fino alla scadenza del periodo di timeout senza nuovi messaggi in arrivo o fino a quando non arriva un messaggio il cui CorrelationId corrisponde al correlationId parametro .

La CorrelationId proprietà viene utilizzata per collegare un messaggio inviato alla coda a messaggi di risposta, report o riconoscimento associati.

Altri due metodi consentono di visualizzare i messaggi in una coda. Il Peek metodo restituisce il primo messaggio nella coda e il PeekById(String) metodo viene utilizzato per recuperare un messaggio specificando il relativo identificatore univoco.

Nella tabella seguente viene illustrato se questo metodo è disponibile in varie modalità gruppo di lavoro.

Modalità gruppo di lavoro	Disponibile
Computer locale	Sì
Computer locale e nome del formato diretto	Sì
Computer remoto	No
Nome del formato diretto e del computer remoto	Sì

Vedi anche

• InfiniteTimeout
• CorrelationId
• Peek()
• BeginPeek()