Поделиться через

XmlMessageFormatter Конструкторы

  • Ссылка

Определение

Пространство имен:
System.Messaging
Сборка:
System.Messaging.dll

Инициализирует новый экземпляр класса XmlMessageFormatter.

Перегрузки

XmlMessageFormatter()

Инициализирует новый экземпляр класса XmlMessageFormatter без набора типов целевых объектов.
XmlMessageFormatter(String[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив (полностью определенных) строковых значений.
XmlMessageFormatter(Type[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив типов объектов.

XmlMessageFormatter()

Инициализирует новый экземпляр класса XmlMessageFormatter без набора типов целевых объектов.

public:
 XmlMessageFormatter();
public XmlMessageFormatter ();
Public Sub New ()

Комментарии

Эта перегрузка конструктора чаще всего используется при записи в очередь, так как целевые типы при записи не требуются.

Чтобы прочитать сообщение из очереди с помощью экземпляра , созданного XmlMessageFormatter с помощью этого конструктора, необходимо задать TargetTypeNames свойства или TargetTypes , чтобы модуль форматирования знал, какие типы следует предпринять для десериализации.

При создании нового MessageQueueсоздается экземпляр по умолчанию XmlMessageFormatter без заданных целевых типов. Как и в случае с модульом форматирования, созданным с помощью этого конструктора, необходимо задать целевые типы для этого экземпляра модуля форматирования, если вы хотите считывать данные из очереди.

Применяется к

XmlMessageFormatter(String[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив (полностью определенных) строковых значений.

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())

Параметры

targetTypeNames
String[]

Массив типа String, задающий набор возможных типов, десериализация которых будет выполняться модулем форматирования из предоставляемого сообщения. Эти значения должны быть полностью определены, например, "MyNamespace.MyOrders, MyOrdersAssemblyName".

Исключения

ArgumentNullException

Параметр targetTypeNames имеет значение null.

Примеры

#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

Комментарии

Конструкторы с параметрами целевого типа чаще всего используются при чтении из очереди. При записи не нужно указывать целевые типы.

Эта перегрузка конструктора XmlMessageFormatter задает свойству TargetTypeNames значения массива, передаваемые targetTypeNames через параметр . Установка этого свойства позволяет использовать MessageQueue этот XmlMessageFormatter экземпляр для чтения сообщений, содержащих объекты заданных типов.

TargetTypeNames Свойства и TargetTypes сообщают модульу форматирования, какие схемы следует пытаться сопоставить при десериализации сообщения. Это позволяет форматировщику интерпретировать текст сообщения.

Экземпляр, сериализованный в тексте сообщения, должен соответствовать одной из схем, представленных в массиве типов. При чтении сообщения с помощью Receive метода метод создает объект типа , соответствующий определенной схеме, и считывает в него текст сообщения.

При чтении из очереди необходимо задать только одно из двух свойств, но можно задать оба свойства. Набор типов — это объединенный набор из двух свойств. Решение о том, какой из них следует использовать, зависит от вашего приложения. Если текст сообщения содержит тип, схема которого не соответствует ни одному из типов в массиве для любого из свойств, во время чтения будет выдано исключение.

Применяется к

XmlMessageFormatter(Type[])

Инициализирует новый экземпляр класса XmlMessageFormatter, устанавливая типы целевых объектов, передаваемых как массив типов объектов.

public:
 XmlMessageFormatter(cli::array <Type ^> ^ targetTypes);
public XmlMessageFormatter (Type[] targetTypes);
new System.Messaging.XmlMessageFormatter : Type[] -> System.Messaging.XmlMessageFormatter
Public Sub New (targetTypes As Type())

Параметры

targetTypes
Type[]

Массив типа Type, задающий набор возможных типов, десериализация которых будет выполняться модулем форматирования из предоставляемого сообщения.

Исключения

ArgumentNullException

Параметр targetTypes имеет значение null.

Комментарии

Конструкторы с параметрами целевого типа чаще всего используются при чтении из очереди. При записи не нужно указывать целевые типы.

Эта перегрузка конструктора XmlMessageFormatter задает свойству TargetTypes значения массива, передаваемые targetTypes через параметр . Задание этого свойства позволяет объекту , использующим MessageQueue этот XmlMessageFormatter экземпляр, считывать сообщения, содержащие объекты заданных типов.

TargetTypeNames Свойства и TargetTypes сообщают модульу форматирования, какие схемы следует пытаться сопоставить при десериализации сообщения. Это позволяет форматировщику интерпретировать текст сообщения.

Экземпляр, сериализованный в тексте сообщения, должен соответствовать одной из схем, представленных в массиве типов. При чтении сообщения с помощью Receive метода метод создает объект типа , соответствующий определенной схеме, и считывает в него текст сообщения.

При чтении из очереди необходимо задать только одно из двух свойств, но можно задать оба свойства. Набор типов — это объединенный набор из двух свойств. Решение о том, какой из них следует использовать, зависит от вашего приложения. Если текст сообщения содержит тип, схема которого не соответствует ни одному из типов в массиве для любого из свойств, во время чтения будет выдано исключение.

При указании TargetTypes вместо TargetTypeNames, существование типа проверяется во время компиляции, а не во время чтения, что снижает вероятность возникновения ошибок. TargetTypeNames требует, чтобы каждая запись была полной, указывая имя сборки. Кроме того, при работе с несколькими параллельными версиями номер версии также должен быть добавлен к имени целевого типа.

При использовании TargetTypesможно добавить каждый объект (например, ) в список таким образом, MyClassкак показано в следующем коде C#.

TargetTypes = new Type[]{typeof(MyClass)}

Применяется к