XmlMessageFormatter Oluşturucular
Tanım
Önemli
Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.
XmlMessageFormatter sınıfının yeni bir örneğini başlatır.
Aşırı Yüklemeler
| Name | Description |
|---|---|
| XmlMessageFormatter() |
Hedef türleri ayarlanmadan sınıfın XmlMessageFormatter yeni bir örneğini başlatır. |
| XmlMessageFormatter(String[]) |
Sınıfın XmlMessageFormatter yeni bir örneğini başlatır ve bir dizi (tam) dize değeri olarak geçirilen hedef türleri ayarlar. |
| XmlMessageFormatter(Type[]) |
Sınıfın XmlMessageFormatter yeni bir örneğini başlatır ve nesne türleri dizisi olarak geçirilen hedef türleri ayarlar. |
XmlMessageFormatter()
Hedef türleri ayarlanmadan sınıfın XmlMessageFormatter yeni bir örneğini başlatır.
public:
XmlMessageFormatter();
public XmlMessageFormatter();
Public Sub New ()
Açıklamalar
Oluşturucunun bu aşırı yüklemesi, yazarken hedef türler gerekmediğinden kuyruğa yazarken en sık kullanılır.
Bu oluşturucu kullanılarak oluşturulan örneğini XmlMessageFormatter kullanarak bir kuyruktan ileti okumak için, biçimlendiricinin TargetTypeNames seri durumdan çıkarma girişiminde bulunması gereken türleri bilmesi için veya TargetTypes özelliklerini ayarlamanız gerekir.
Yeni MessageQueuebir oluşturduğunuzda, hedef türler ayarlanmadan varsayılan XmlMessageFormatter bir örnek oluşturulur. Bu oluşturucu kullanılarak oluşturulan bir biçimlendiricide olduğu gibi, kuyruktan okumak istiyorsanız bu biçimlendirici örneği için hedef türleri ayarlamanız gerekir.
Şunlara uygulanır
XmlMessageFormatter(String[])
Sınıfın XmlMessageFormatter yeni bir örneğini başlatır ve bir dizi (tam) dize değeri olarak geçirilen hedef türleri ayarlar.
public:
XmlMessageFormatter(cli::array <System::String ^> ^ targetTypeNames);
public XmlMessageFormatter(string[] targetTypeNames);
new System.Messaging.XmlMessageFormatter : string[] -> System.Messaging.XmlMessageFormatter
Public Sub New (targetTypeNames As String())
Parametreler
- targetTypeNames
- String[]
Sağlanan iletiden biçimlendirici tarafından seri durumdan çıkarılacak olası türler kümesini belirten tür String dizisi. Bu değerler tam olarak nitelenmiş olmalıdır, örneğin, "MyNamespace.MyOrders, MyOrdersAssemblyName".
Özel durumlar
targetTypeNames parametresi null'dir.
Örnekler
#using <system.dll>
#using <system.messaging.dll>
#using <system.drawing.dll>
using namespace System;
using namespace System::Messaging;
using namespace System::Drawing;
using namespace System::IO;
ref class Order
{
public:
int orderId;
DateTime orderTime;
};
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()
{
try
{
// Create a new order and set values.
Order^ sentOrder = gcnew Order;
sentOrder->orderId = 3;
sentOrder->orderTime = DateTime::Now;
// Connect to a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Create the new order.
Message^ myMessage = gcnew Message( sentOrder );
// Send the order to the queue.
myQueue->Send( myMessage );
}
catch ( ArgumentException^ e )
{
Console::WriteLine( e->Message );
}
return;
}
void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
// Set the formatter to indicate body contains an Order.
array<Type^>^p = gcnew array<Type^>(1);
p[ 0 ] = Order::typeid;
myQueue->Formatter = gcnew XmlMessageFormatter( p );
try
{
// Receive and format the message.
Message^ myMessage = myQueue->Receive();
Order^ myOrder = dynamic_cast<Order^>(myMessage->Body);
// Display message information.
Console::WriteLine( "Order ID: {0}", myOrder->orderId );
Console::WriteLine( "Sent: {0}", myOrder->orderTime );
}
catch ( MessageQueueException^ )
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch ( InvalidOperationException^ e )
{
Console::WriteLine( e->Message );
}
// Catch other exceptions as necessary.
return;
}
};
int main()
{
// Create a new instance of the class.
MyNewQueue^ myNewQueue = gcnew MyNewQueue;
// Create a queue on the local computer.
MyNewQueue::CreateQueue( ".\\myQueue" );
// Send a message to a queue.
myNewQueue->SendMessage();
// Receive a message from a queue.
myNewQueue->ReceiveMessage();
return 0;
}
using System;
using System.Messaging;
using System.Drawing;
using System.IO;
namespace MyProject
{
// The following example
// sends to a queue and receives from a queue.
public class Order
{
public int orderId;
public DateTime orderTime;
};
/// <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 a queue on the local computer.
CreateQueue(".\\myQueue");
// Send a message to a queue.
myNewQueue.SendMessage();
// Receive a message from a queue.
myNewQueue.ReceiveMessage();
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 an Order to a queue.
//**************************************************
public void SendMessage()
{
try
{
// Create a new order and set values.
Order sentOrder = new Order();
sentOrder.orderId = 3;
sentOrder.orderTime = DateTime.Now;
// Connect to a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Create the new order.
Message myMessage = new Message(sentOrder);
// Send the order to the queue.
myQueue.Send(myMessage);
}
catch(ArgumentException e)
{
Console.WriteLine(e.Message);
}
return;
}
//**************************************************
// Receives a message containing an order.
//**************************************************
public void ReceiveMessage()
{
// Connect to the a queue on the local computer.
MessageQueue myQueue = new MessageQueue(".\\myQueue");
// Set the formatter to indicate body contains an Order.
myQueue.Formatter = new XmlMessageFormatter(new Type[]
{typeof(MyProject.Order)});
try
{
// Receive and format the message.
Message myMessage = myQueue.Receive();
Order myOrder = (Order)myMessage.Body;
// Display message information.
Console.WriteLine("Order ID: " +
myOrder.orderId.ToString());
Console.WriteLine("Sent: " +
myOrder.orderTime.ToString());
}
catch (MessageQueueException)
{
// Handle Message Queuing exceptions.
}
// Handle invalid serialization format.
catch (InvalidOperationException e)
{
Console.WriteLine(e.Message);
}
// Catch other exceptions as necessary.
return;
}
}
}
Imports System.Messaging
Imports System.Drawing
Imports System.IO
' The following example
' sends to a queue and receives from a queue.
Public Class Order
Public orderId As Integer
Public orderTime As DateTime
End Class
' 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 a queue on the local computer.
CreateQueue(".\myQueue")
' Send a message to a queue.
myNewQueue.SendMessage()
' Receive a message from a queue.
myNewQueue.ReceiveMessage()
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 an Order to a queue.
Public Sub SendMessage()
Try
' Create a new order and set values.
Dim sentOrder As New Order()
sentOrder.orderId = 3
sentOrder.orderTime = DateTime.Now
' Connect to a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Create the new order.
Dim myMessage As New Message(sentOrder)
' Send the order to the queue.
myQueue.Send(myMessage)
Catch e As ArgumentException
Console.WriteLine(e.Message)
End Try
Return
End Sub
' Receives a message containing an order.
Public Sub ReceiveMessage()
' Connect to the a queue on the local computer.
Dim myQueue As New MessageQueue(".\myQueue")
' Set the formatter to indicate body contains an Order.
myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(Order)})
Try
' Receive and format the message.
Dim myMessage As Message = myQueue.Receive()
Dim myOrder As Order = CType(myMessage.Body, Order)
' Display message information.
Console.WriteLine(("Order ID: " + myOrder.orderId.ToString()))
Console.WriteLine(("Sent: " + myOrder.orderTime.ToString()))
' Handle invalid serialization format.
Catch e As InvalidOperationException
Console.WriteLine(e.Message)
End Try
' Catch other exceptions as necessary.
Return
End Sub
End Class
Açıklamalar
Hedef tür parametrelerine sahip oluşturucular en sık kuyruktan okurken kullanılır. Yazarken, hedef türlerin belirtilmesi gerekmez.
Oluşturucunun XmlMessageFormatter bu aşırı yüklemesi, özelliğini parametresi aracılığıyla geçirilen dizi değerlerine targetTypeNames ayarlarTargetTypeNames. Bu özelliğin ayarlanması, bu XmlMessageFormatter örneği kullanarak belirli türlerdeki nesneleri içeren iletileri okumasına olanak tanırMessageQueue.
TargetTypeNames Hem hem de TargetTypes özellikleri, biçimlendiriciye bir iletinin seri durumdan çıkarılırken hangi şemaların eşleşmeye çalışacaklarını söyler. Bu, biçimlendiricinin ileti gövdesini yorumlamasına olanak tanır.
İleti gövdesinde seri hale getirilmiş örneğin tür dizisinde temsil edilen şemalardan biriyle uyumlu olması gerekir. yöntemini kullanarak Receive iletiyi okuduğunuzda, yöntemi tanımlanan şemaya karşılık gelen türde bir nesnesi oluşturur ve ileti gövdesini bu şemaya okur.
Kuyruktan okurken iki özellikten yalnızca birinin ayarlanması gerekir, ancak her ikisini de ayarlayabilirsiniz. Tür kümesi, iki özellikten birleştirilmiş kümedir. Hangisinin kullanılacağına karar, uygulamanıza özgüdür. İleti gövdesi, şeması her iki özellik için de dizideki türlerden herhangi biriyle eşleşmeyen bir tür içeriyorsa, okuma zamanında bir özel durum oluşturulur.
Şunlara uygulanır
XmlMessageFormatter(Type[])
Sınıfın XmlMessageFormatter yeni bir örneğini başlatır ve nesne türleri dizisi olarak geçirilen hedef türleri ayarlar.
public:
XmlMessageFormatter(cli::array <Type ^> ^ targetTypes);
public XmlMessageFormatter(Type[] targetTypes);
new System.Messaging.XmlMessageFormatter : Type[] -> System.Messaging.XmlMessageFormatter
Public Sub New (targetTypes As Type())
Parametreler
- targetTypes
- Type[]
Sağlanan iletiden biçimlendirici tarafından seri durumdan çıkarılacak olası türler kümesini belirten tür Type dizisi.
Özel durumlar
targetTypes parametresi null'dir.
Açıklamalar
Hedef tür parametrelerine sahip oluşturucular en sık kuyruktan okurken kullanılır. Yazarken, hedef türlerin belirtilmesi gerekmez.
Oluşturucunun XmlMessageFormatter bu aşırı yüklemesi, özelliğini parametresi aracılığıyla geçirilen dizi değerlerine targetTypes ayarlarTargetTypes. Bu özelliğin ayarlanması, bu XmlMessageFormatter örneğin belirli türlerdeki nesneleri içeren iletileri okumasını sağlarMessageQueue.
TargetTypeNames Hem hem de TargetTypes özellikleri, biçimlendiriciye bir iletinin seri durumdan çıkarılırken hangi şemaların eşleşmeye çalışacaklarını söyler. Bu, biçimlendiricinin ileti gövdesini yorumlamasına olanak tanır.
İleti gövdesinde seri hale getirilmiş örneğin tür dizisinde temsil edilen şemalardan biriyle uyumlu olması gerekir. yöntemini kullanarak Receive iletiyi okuduğunuzda, yöntemi tanımlanan şemaya karşılık gelen türde bir nesnesi oluşturur ve ileti gövdesini bu şemaya okur.
Kuyruktan okurken iki özellikten yalnızca birinin ayarlanması gerekir, ancak her ikisini de ayarlayabilirsiniz. Tür kümesi, iki özellikten birleştirilmiş kümedir. Hangisinin kullanılacağına karar, uygulamanıza özgüdür. İleti gövdesi, şeması her iki özellik için de dizideki türlerden herhangi biriyle eşleşmeyen bir tür içeriyorsa, okuma zamanında bir özel durum oluşturulur.
yerine TargetTypeNamesbelirtirkenTargetTypes, tür varlığı okuma zamanı yerine derleme zamanında denetlenerek hata olasılığını azaltır. TargetTypeNames her girişin tam olarak nitelenmiş olmasını gerektirir ve derleme adını belirtir. Ayrıca, birden çok eşzamanlı sürümle çalışırken, sürüm numarasının da hedef tür adına eklenmesi gerekir.
kullanırken TargetTypes, her nesneyi (örneğin, MyClass) aşağıdaki C# koduyla gösterildiği şekilde listeye ekleyebilirsiniz.
TargetTypes = new Type[]{typeof(MyClass)}