MessageQueue.ReceiveByCorrelationId Methode
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Ontvangt een bericht dat overeenkomt met een bepaalde correlatie-id.
Overloads
| Name | Description |
|---|---|
| ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt. |
| ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een transactionele wachtrij) en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt. |
| ReceiveByCorrelationId(String, TimeSpan) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een niet-transactionele wachtrij) en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt. |
| ReceiveByCorrelationId(String, MessageQueueTransactionType) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat. |
| ReceiveByCorrelationId(String, MessageQueueTransaction) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een transactionele wachtrij) en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat. |
| ReceiveByCorrelationId(String) |
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een niet-transactionele wachtrij) en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat. |
ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
- timeout
- TimeSpan
A TimeSpan die aangeeft hoe lang moet worden gewacht totdat een nieuw bericht beschikbaar is voor inspectie.
- transactionType
- MessageQueueTransactionType
Een van de MessageQueueTransactionType waarden die het type transactiecontext beschrijven dat aan het bericht moet worden gekoppeld.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
De correlationId parameter is null.
Het bericht met de opgegeven correlationId kan niet worden gevonden.
De opgegeven waarde voor de timeout parameter is ongeldig, mogelijk timeout kleiner dan Zero of groter dan InfiniteTimeout.
De transactionType parameter is geen van de MessageQueueTransactionType leden.
Het bericht met de opgegeven correlationId waarde bestaat niet in de wachtrij en komt niet binnen voordat de time-out is verlopen.
– of –
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld ziet u het gebruik van ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType).
// Connect to a nontransactional queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Create a new message.
Message^ msg = gcnew Message("Example Message Body");
// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");
// Get the message's Id property value.
String^ id = msg->Id;
// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue^ transQueue =
gcnew MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;
// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType::Single);
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;
// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
TimeSpan::FromSeconds(10.0), MessageQueueTransactionType::Single);
// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
responseMsg->CorrelationId);
transQueue->Close();
queue->Close();
// Connect to a nontransactional queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Create a new message.
Message msg = new Message("Example Message Body");
// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");
// Get the message's Id property value.
string id = msg.Id;
// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue transQueue = new MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;
// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType.Single);
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;
// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
TimeSpan.FromSeconds(10.0), MessageQueueTransactionType.Single);
// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
responseMsg.CorrelationId);
Opmerkingen
Deze methode zoekt in de wachtrij waarnaar wordt verwezen door het MessageQueue bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Deze methode retourneert onmiddellijk als het bericht met de correlatie-id die is opgegeven door de correlationId parameter zich in de wachtrij bevindt, met behulp van een transactiecontext die is gedefinieerd door de transactionType parameter. Anders wacht de methode de opgegeven periode totdat een nieuw bericht binnenkomt. Als er geen nieuw bericht binnenkomt voordat de time-out verloopt, wordt er een uitzondering gegenereerd.
De timeout parameter geeft de totale uitvoeringsduur voor deze methode niet op. In plaats daarvan geeft het de tijd op waarop moet worden gewacht tot een nieuw bericht in de wachtrij aankomt. Telkens wanneer een nieuw bericht binnenkomt, onderzoekt deze methode het CorrelationId nieuwe bericht om te zien of het overeenkomt met de correlationId parameter. Zo niet, dan wordt met deze methode de time-outperiode gestart en wordt gewacht tot er een nieuw bericht binnenkomt. Als nieuwe berichten binnen de time-outperiode blijven binnenkomen, is het daarom mogelijk dat deze methode voor onbepaalde tijd wordt uitgevoerd, totdat de time-outperiode verloopt zonder dat er nieuwe berichten binnenkomen of totdat een bericht binnenkomt waarvan CorrelationId de correlationId parameter overeenkomt. Geef Automatic op voor de transactionType parameter als er al een externe transactiecontext is gekoppeld aan de thread die u wilt gebruiken om het bericht te ontvangen. Geef op Single of u het bericht wilt ontvangen als één interne transactie. U kunt opgeven None of u een bericht wilt ontvangen van een transactionele wachtrij buiten een transactiecontext.
Als deze methode wordt aangeroepen om een bericht te ontvangen van een transactionele wachtrij, wordt het bericht dat wordt ontvangen, geretourneerd naar de wachtrij als de transactie wordt afgebroken. Het bericht wordt pas definitief uit de wachtrij verwijderd nadat de transactie is doorgevoerd.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode wordt gebruikt om een bericht op te halen door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt. Er is geen transactiecontext gekoppeld aan een bericht dat wordt geretourneerd door een aanroep naar PeekByCorrelationId(String). Omdat PeekByCorrelationId(String) er geen berichten in de wachtrij worden verwijderd, is er niets om terug te draaien als de transactie is afgebroken.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |
Zie ook
Van toepassing op
ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een transactionele wachtrij) en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transaction As MessageQueueTransaction) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
- timeout
- TimeSpan
A TimeSpan die aangeeft hoe lang moet worden gewacht totdat een nieuw bericht beschikbaar is voor inspectie.
- transaction
- MessageQueueTransaction
Het MessageQueueTransaction-object.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
De opgegeven waarde voor de timeout parameter is ongeldig, mogelijk timeout kleiner dan Zero of groter dan InfiniteTimeout.
Het bericht met de opgegeven correlationId waarde bestaat niet in de wachtrij en komt niet binnen voordat de time-out is verlopen.
– of –
De wachtrij is niet-transactioneel.
– of –
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld ziet u het gebruik van ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction).
// Connect to a nontransactional queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Create a new message.
Message^ msg = gcnew Message("Example Message Body");
// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");
// Get the message's Id property value.
String^ id = msg->Id;
// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue^ transQueue =
gcnew MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;
// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType::Single);
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;
// Create a message queuing transaction.
MessageQueueTransaction^ transaction = gcnew MessageQueueTransaction();
try
{
// Begin a transaction.
transaction->Begin();
// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
TimeSpan::FromSeconds(10.0), transaction);
// Commit the transaction.
transaction->Commit();
}
catch (Exception^ ex)
{
// Cancel the transaction.
transaction->Abort();
// Propagate the exception.
throw ex;
}
finally
{
// Dispose of the transaction object.
delete transaction;
transQueue->Close();
queue->Close();
}
// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
responseMsg->CorrelationId);
// Connect to a nontransactional queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Create a new message.
Message msg = new Message("Example Message Body");
// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");
// Get the message's Id property value.
string id = msg.Id;
// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue transQueue = new MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;
// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType.Single);
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;
// Create a message queuing transaction.
MessageQueueTransaction transaction = new MessageQueueTransaction();
try
{
// Begin a transaction.
transaction.Begin();
// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
TimeSpan.FromSeconds(10.0), transaction);
// Commit the transaction.
transaction.Commit();
}
catch (System.Exception e)
{
// Cancel the transaction.
transaction.Abort();
// Propagate the exception.
throw e;
}
finally
{
// Dispose of the transaction object.
transaction.Dispose();
}
// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
responseMsg.CorrelationId);
Opmerkingen
Deze methode zoekt in de transactionele wachtrij waarnaar wordt verwezen door het MessageQueue voor een bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Deze methode retourneert onmiddellijk als het bericht met de correlatie-id die is opgegeven door de correlationId parameter zich in de wachtrij bevindt, met behulp van de interne transactiecontext die is gedefinieerd door de transaction parameter. Anders wacht de methode de opgegeven periode totdat een nieuw bericht binnenkomt. Als er geen nieuw bericht binnenkomt voordat de time-out verloopt, wordt er een uitzondering gegenereerd.
De timeout parameter geeft de totale uitvoeringsduur voor deze methode niet op. In plaats daarvan geeft het de tijd op waarop moet worden gewacht tot een nieuw bericht in de wachtrij aankomt. Telkens wanneer een nieuw bericht binnenkomt, onderzoekt deze methode het CorrelationId nieuwe bericht om te zien of het overeenkomt met de correlationId parameter. Zo niet, dan wordt met deze methode de time-outperiode gestart en wordt gewacht tot er een nieuw bericht binnenkomt. Als nieuwe berichten binnen de time-outperiode blijven binnenkomen, is het daarom mogelijk dat deze methode voor onbepaalde tijd wordt uitgevoerd, totdat de time-outperiode verloopt zonder dat er nieuwe berichten binnenkomen of totdat een bericht binnenkomt waarvan CorrelationId de correlationId parameter overeenkomt.
Omdat deze methode wordt aangeroepen in een transactionele wachtrij, wordt het ontvangen bericht geretourneerd naar de wachtrij als de transactie wordt afgebroken. Het bericht wordt pas definitief uit de wachtrij verwijderd nadat de transactie is doorgevoerd.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode wordt gebruikt om een bericht op te halen door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt. Er is geen transactiecontext gekoppeld aan een bericht dat wordt geretourneerd door een aanroep naar PeekByCorrelationId(String). Omdat PeekByCorrelationId(String) er geen berichten in de wachtrij worden verwijderd, is er niets om terug te draaien als de transactie is afgebroken.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |
Zie ook
Van toepassing op
ReceiveByCorrelationId(String, TimeSpan)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een niet-transactionele wachtrij) en wacht totdat een bericht met de opgegeven correlatie-id beschikbaar is in de wachtrij of de time-out verloopt.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId, TimeSpan timeout);
member this.ReceiveByCorrelationId : string * TimeSpan -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
- timeout
- TimeSpan
A TimeSpan die aangeeft hoe lang moet worden gewacht totdat een nieuw bericht beschikbaar is voor inspectie.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
De correlationId parameter is null.
De opgegeven waarde voor de timeout parameter is ongeldig, mogelijk timeout kleiner dan Zero of groter dan InfiniteTimeout.
Het bericht met de opgegeven correlationId waarde bestaat niet in de wachtrij en komt niet binnen voordat de time-out is verlopen.
– of –
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld ziet u het gebruik van ReceiveByCorrelationId(String, TimeSpan).
// Connect to a queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Create a new message.
Message^ msg = gcnew Message("Example Message Body");
// Designate a queue to receive the acknowledgement message for this
// message.
msg->AdministrationQueue =
gcnew 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 =
gcnew 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;
// Receive the acknowledgement message from the admin queue.
Message^ ackMsg = adminQueue->ReceiveByCorrelationId(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);
adminQueue->Close();
queue->Close();
// 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;
// Receive the acknowledgement message from the admin queue.
Message ackMsg = adminQueue.ReceiveByCorrelationId(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);
Opmerkingen
Deze methode zoekt in de niet-transactionele wachtrij waarnaar wordt verwezen door het MessageQueue voor een bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Deze methode retourneert onmiddellijk als het bericht met de correlatie-id die is opgegeven door de correlationId parameter zich in de wachtrij bevindt. Anders wacht de methode de opgegeven periode totdat een nieuw bericht binnenkomt. Als er geen nieuw bericht binnenkomt voordat de time-out verloopt, wordt er een uitzondering gegenereerd.
De timeout parameter geeft de totale uitvoeringsduur voor deze methode niet op. In plaats daarvan geeft het de tijd op waarop moet worden gewacht tot een nieuw bericht in de wachtrij aankomt. Telkens wanneer een nieuw bericht binnenkomt, onderzoekt deze methode het CorrelationId nieuwe bericht om te zien of het overeenkomt met de correlationId parameter. Zo niet, dan wordt met deze methode de time-outperiode gestart en wordt gewacht tot er een nieuw bericht binnenkomt. Als nieuwe berichten binnen de time-outperiode blijven binnenkomen, is het daarom mogelijk dat deze methode voor onbepaalde tijd wordt uitgevoerd, totdat de time-outperiode verloopt zonder dat er nieuwe berichten binnenkomen of totdat een bericht binnenkomt waarvan CorrelationId de correlationId parameter overeenkomt.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode wordt gebruikt om een bericht op te halen door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |
Zie ook
Van toepassing op
ReceiveByCorrelationId(String, MessageQueueTransactionType)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, transactionType As MessageQueueTransactionType) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
- transactionType
- MessageQueueTransactionType
Een van de MessageQueueTransactionType waarden die het type transactiecontext beschrijven dat aan het bericht moet worden gekoppeld.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
De correlationId parameter is null.
Het bericht met de opgegeven correlationId kan niet worden gevonden.
De transactionType parameter is geen van de MessageQueueTransactionType leden.
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld ziet u het gebruik van ReceiveByCorrelationId(String, MessageQueueTransactionType).
// Connect to a nontransactional queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Create a new message.
Message^ msg = gcnew Message("Example Message Body");
// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");
// Get the message's Id property value.
String^ id = msg->Id;
// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue^ transQueue =
gcnew MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;
// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType::Single);
// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;
// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
MessageQueueTransactionType::Single);
// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
responseMsg->CorrelationId);
transQueue->Close();
queue->Close();
// Connect to a nontransactional queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Create a new message.
Message msg = new Message("Example Message Body");
// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");
// Get the message's Id property value.
string id = msg.Id;
// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue transQueue = new MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;
// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType.Single);
// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;
// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
MessageQueueTransactionType.Single);
// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
responseMsg.CorrelationId);
Opmerkingen
Deze methode zoekt in de wachtrij waarnaar wordt verwezen door het MessageQueue bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Als er geen bericht wordt gevonden dat overeenkomt met de correlationID parameter, wordt er een uitzondering gegenereerd. Anders wordt het bericht uit de wachtrij verwijderd en geretourneerd naar de toepassing met behulp van een transactiecontext die is gedefinieerd door de transactionType parameter.
Geef Automatic op voor de transactionType parameter als er al een externe transactiecontext is gekoppeld aan de thread die u wilt gebruiken om het bericht te ontvangen. Geef op Single of u het bericht wilt ontvangen als één interne transactie. U kunt opgeven None of u een bericht wilt ontvangen van een transactionele wachtrij buiten een transactiecontext.
Als deze methode wordt aangeroepen om een bericht te ontvangen van een transactionele wachtrij, wordt het bericht dat wordt ontvangen, geretourneerd naar de wachtrij als de transactie wordt afgebroken. Het bericht wordt pas definitief uit de wachtrij verwijderd nadat de transactie is doorgevoerd.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode wordt gebruikt om een bericht op te halen door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt. Er is geen transactiecontext gekoppeld aan een bericht dat wordt geretourneerd door een aanroep naar PeekByCorrelationId(String). Omdat PeekByCorrelationId(String) er geen berichten in de wachtrij worden verwijderd, is er niets om terug te draaien als de transactie is afgebroken.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |
Zie ook
Van toepassing op
ReceiveByCorrelationId(String, MessageQueueTransaction)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een transactionele wachtrij) en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, transaction As MessageQueueTransaction) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
- transaction
- MessageQueueTransaction
Het MessageQueueTransaction-object.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
Het bericht met de opgegeven correlationId kan niet worden gevonden.
De wachtrij is niet-transactioneel.
– of –
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld ziet u het gebruik van ReceiveByCorrelationId(String, MessageQueueTransaction).
// Connect to a nontransactional queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Create a new message.
Message^ msg = gcnew Message("Example Message Body");
// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");
// Get the message's Id property value.
String^ id = msg->Id;
// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue^ transQueue =
gcnew MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;
// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType::Single);
// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;
// Create a message queuing transaction.
MessageQueueTransaction^ transaction = gcnew MessageQueueTransaction();
try
{
// Begin a transaction.
transaction->Begin();
// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id, transaction);
// Commit the transaction.
transaction->Commit();
}
catch (Exception^ ex)
{
// Cancel the transaction.
transaction->Abort();
// Propagate the exception.
throw ex;
}
finally
{
// Dispose of the transaction object.
delete transaction;
transQueue->Close();
queue->Close();
}
// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
responseMsg->CorrelationId);
// Connect to a nontransactional queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Create a new message.
Message msg = new Message("Example Message Body");
// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");
// Get the message's Id property value.
string id = msg.Id;
// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));
// Connect to a transactional queue on the local computer.
MessageQueue transQueue = new MessageQueue(".\\exampleTransQueue");
// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");
// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;
// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
MessageQueueTransactionType.Single);
// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));
// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;
// Create a message queuing transaction.
MessageQueueTransaction transaction = new MessageQueueTransaction();
try
{
// Begin a transaction.
transaction.Begin();
// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id, transaction);
// Commit the transaction.
transaction.Commit();
}
catch (System.Exception e)
{
// Cancel the transaction.
transaction.Abort();
// Propagate the exception.
throw e;
}
finally
{
// Dispose of the transaction object.
transaction.Dispose();
}
// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
responseMsg.CorrelationId);
Opmerkingen
Deze methode zoekt in de transactionele wachtrij waarnaar wordt verwezen door het MessageQueue voor een bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Als er geen bericht wordt gevonden dat overeenkomt met de correlationID parameter, wordt er een uitzondering gegenereerd. Anders wordt het bericht uit de wachtrij verwijderd en geretourneerd naar de toepassing met behulp van de interne transactiecontext die is gedefinieerd door de transaction parameter.
Omdat deze methode wordt aangeroepen in een transactionele wachtrij, wordt het ontvangen bericht geretourneerd naar de wachtrij als de transactie wordt afgebroken. Het bericht wordt pas definitief uit de wachtrij verwijderd nadat de transactie is doorgevoerd.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode wordt gebruikt om een bericht op te halen door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt. Er is geen transactiecontext gekoppeld aan een bericht dat wordt geretourneerd door een aanroep naar PeekByCorrelationId(String). Omdat PeekByCorrelationId(String) er geen berichten in de wachtrij worden verwijderd, is er niets om terug te draaien als de transactie is afgebroken.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |
Zie ook
Van toepassing op
ReceiveByCorrelationId(String)
Ontvangt het bericht dat overeenkomt met de opgegeven correlatie-id (uit een niet-transactionele wachtrij) en genereert onmiddellijk een uitzondering als er momenteel geen bericht met de opgegeven correlatie-id in de wachtrij bestaat.
public:
System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId);
public System.Messaging.Message ReceiveByCorrelationId(string correlationId);
member this.ReceiveByCorrelationId : string -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String) As Message
Parameters
- correlationId
- String
Het CorrelationId bericht dat moet worden ontvangen.
Retouren
Waarvan Message de parameter overeenkomt met CorrelationId de correlationId parameter die is doorgegeven.
Uitzonderingen
De correlationId parameter is null.
Het bericht met de opgegeven correlationId kan niet worden gevonden.
Er is een fout opgetreden bij het openen van een Message Queuing-methode.
Voorbeelden
In het volgende codevoorbeeld wordt een bericht met een order naar en van een wachtrij verzonden en ontvangen. Er wordt specifiek een positieve bevestiging aangevraagd wanneer het oorspronkelijke bericht wordt bereikt of uit de wachtrij wordt opgehaald.
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
static void CreateQueue( String^ queuePath )
{
try
{
if ( !MessageQueue::Exists( queuePath ) )
{
MessageQueue::Create( queuePath );
}
else
{
Console::WriteLine( "{0} already exists.", queuePath );
}
}
catch ( MessageQueueException^ e )
{
Console::WriteLine( e->Message );
}
}
void SendMessage()
{
// Connect to a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Create a new message.
Message^ myMessage = gcnew Message( "Original Message" );
myMessage->AdministrationQueue = gcnew MessageQueue( ".\\myAdministrationQueue" );
myMessage->AcknowledgeType = (AcknowledgeTypes)(AcknowledgeTypes::PositiveReceive | AcknowledgeTypes::PositiveArrival);
// Send the Order to the queue.
myQueue->Send( myMessage );
return;
}
String^ ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
myQueue->MessageReadPropertyFilter->CorrelationId = true;
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = String::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
String^ returnString = nullptr;
try
{
// Receive and format the message.
Message^ myMessage = myQueue->Receive();
// Display message information.
Console::WriteLine( "____________________________________________" );
Console::WriteLine( "Original message information--" );
Console::WriteLine( "Body: {0}", myMessage->Body );
Console::WriteLine( "Id: {0}", myMessage->Id );
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;
}
void ReceiveAcknowledgment( String^ messageId, String^ queuePath )
{
bool found = false;
MessageQueue^ queue = gcnew MessageQueue( queuePath );
queue->MessageReadPropertyFilter->CorrelationId = true;
queue->MessageReadPropertyFilter->Acknowledgment = true;
try
{
while ( queue->PeekByCorrelationId( messageId ) != nullptr )
{
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: {0}", myAcknowledgmentMessage->CorrelationId );
Console::WriteLine( "Id: {0}", myAcknowledgmentMessage->Id );
Console::WriteLine( "Acknowledgment Type: {0}", myAcknowledgmentMessage->Acknowledgment );
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 )
{
Console::WriteLine( e->Message );
}
// Handle other causes of invalid operation exception.
}
}
};
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Create new queues.
MyNewQueue::CreateQueue( ".\\myQueue" );
MyNewQueue::CreateQueue( ".\\myAdministrationQueue" );
// Send messages to a queue.
myNewQueue->SendMessage();
// Receive messages from a queue.
String^ messageId = myNewQueue->ReceiveMessage();
// Receive acknowledgment message.
if ( messageId != nullptr )
{
myNewQueue->ReceiveAcknowledgment( messageId, ".\\myAdministrationQueue" );
}
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 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)
{
Console.WriteLine(e.Message);
}
// Handle other causes of invalid operation exception.
}
}
}
}
Imports System.Messaging
' Provides a container class for the example.
Public Class MyNewQueue
' Provides an entry point into the application.
' This example sends and receives a message from
' a queue.
Public Shared Sub Main()
' Create a new instance of the class.
Dim myNewQueue As New MyNewQueue()
' Create new queues.
CreateQueue(".\myQueue")
CreateQueue(".\myAdministrationQueue")
' Send messages to a queue.
myNewQueue.SendMessage()
' Receive messages from a queue.
Dim messageId As String = myNewQueue.ReceiveMessage()
' Receive acknowledgment message.
If Not (messageId Is Nothing) Then
myNewQueue.ReceiveAcknowledgment(messageId, ".\myAdministrationQueue")
End If
Return
End Sub
' Creates a new queue.
Public Shared Sub CreateQueue(queuePath As String)
Try
If Not MessageQueue.Exists(queuePath) Then
MessageQueue.Create(queuePath)
Else
Console.WriteLine((queuePath + " already exists."))
End If
Catch e As MessageQueueException
Console.WriteLine(e.Message)
End Try
End Sub
' Sends a string message to a queue.
Public Sub SendMessage()
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Create a new message.
Dim myMessage As New Message("Original Message")
myMessage.AdministrationQueue = New MessageQueue(".\myAdministrationQueue")
myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive Or AcknowledgeTypes.PositiveArrival
' Send the Order to the queue.
myQueue.Send(myMessage)
Return
End Sub
' Receives a message containing an Order.
Public Function ReceiveMessage() As String
' Connect to the a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
myQueue.MessageReadPropertyFilter.CorrelationId = True
' Set the formatter to indicate body contains an Order.
myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
Dim returnString As String = Nothing
Try
' Receive and format the message.
Dim myMessage As Message = 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
' Handle invalid serialization format.
Catch e As InvalidOperationException
Console.WriteLine(e.Message)
End Try
' Catch other exceptions as necessary.
Return returnString
End Function 'ReceiveMessage
' Receives a message containing an Order.
Public Sub ReceiveAcknowledgment(messageId As String, queuePath As String)
Dim found As Boolean = False
Dim queue As New MessageQueue(queuePath)
queue.MessageReadPropertyFilter.CorrelationId = True
queue.MessageReadPropertyFilter.Acknowledgment = True
Try
While Not (queue.PeekByCorrelationId(messageId) Is Nothing)
Dim myAcknowledgmentMessage As Message = 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
End While
Catch e As InvalidOperationException
' 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 Then
Console.WriteLine(e.Message)
End If
End Try
End Sub
End Class
Opmerkingen
Deze methode zoekt in de niet-transactionele wachtrij waarnaar wordt verwezen door het MessageQueue voor een bericht waarvan CorrelationId deze overeenkomt met de opgegeven correlationId parameter. Als er geen bericht wordt gevonden dat overeenkomt met de correlationID parameter, wordt er een uitzondering gegenereerd. Anders wordt het bericht uit de wachtrij verwijderd en geretourneerd naar de toepassing.
De CorrelationId eigenschap wordt gebruikt om een bericht dat naar de wachtrij wordt verzonden, te koppelen aan gekoppelde antwoord-, rapport- of bevestigingsberichten.
Met twee andere methoden kunt u berichten van een wachtrij ontvangen. De Receive methode retourneert het eerste bericht in de wachtrij en de methode haalt een bericht op door de ReceiveById(String) unieke id op te geven.
Als u een bericht met een opgegeven correlatie-id wilt lezen zonder het uit de wachtrij te verwijderen, gebruikt u de PeekByCorrelationId(String) methode. De PeekByCorrelationId(String) methode retourneert altijd het eerste bericht in de wachtrij, zodat volgende aanroepen naar de methode hetzelfde bericht retourneren, tenzij een bericht met een hogere prioriteit in de wachtrij binnenkomt.
In de volgende tabel ziet u of deze methode beschikbaar is in verschillende werkgroepmodi.
| Werkgroepmodus | Available |
|---|---|
| Lokale computer | Ja |
| Naam van lokale computer en directe indeling | Ja |
| Externe computer | No |
| Naam van externe computer en directe indeling | Ja |