Compartir a través de

XmlMessageFormatter Constructores

  • Referencia

Definición

Espacio de nombres:
System.Messaging
Ensamblado:
System.Messaging.dll

Inicializa una nueva instancia de la clase XmlMessageFormatter.

Sobrecargas

XmlMessageFormatter()

Inicializa una nueva instancia de la clase XmlMessageFormatter sin los tipos de destino establecidos.
XmlMessageFormatter(String[])

Inicializa una nueva instancia de la clase XmlMessageFormatter, estableciendo los tipos de destino pasados en forma de matriz de valores de cadena completos.
XmlMessageFormatter(Type[])

Inicializa una nueva instancia de la clase XmlMessageFormatter, estableciendo los tipos de destino pasados en forma matriz de tipos de objetos.

XmlMessageFormatter()

Inicializa una nueva instancia de la clase XmlMessageFormatter sin los tipos de destino establecidos.

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

Comentarios

Esta sobrecarga del constructor se usa con más frecuencia al escribir en la cola, ya que los tipos de destino no son necesarios al escribir.

Para leer un mensaje de una cola mediante una instancia de XmlMessageFormatter creada mediante este constructor, debe establecer las TargetTypeNames propiedades o TargetTypes para que el formateador sepa qué tipos intentar deserializar.

Al crear un nuevo MessageQueue, se crea una instancia predeterminada XmlMessageFormatter , sin los tipos de destino establecidos. Al igual que con un formateador creado con este constructor, debe establecer los tipos de destino para esa instancia de formateador si desea leer desde la cola.

Se aplica a

XmlMessageFormatter(String[])

Inicializa una nueva instancia de la clase XmlMessageFormatter, estableciendo los tipos de destino pasados en forma de matriz de valores de cadena completos.

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

Parámetros

targetTypeNames
String[]

Matriz de tipo String que especifica el conjunto de tipos posibles que deserializará el formateador a partir del mensaje proporcionado. Estos valores tienen que ser completos, por ejemplo, "MyNamespace.MyOrders, MyOrdersAssemblyName".

Excepciones

ArgumentNullException

El parámetro targetTypeNames es null.

Ejemplos

#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

Comentarios

Los constructores con parámetros de tipo de destino se usan con más frecuencia al leer desde la cola. Al escribir, no es necesario especificar tipos de destino.

Esta sobrecarga del XmlMessageFormatter constructor establece la TargetTypeNames propiedad en los valores de matriz pasados a través del targetTypeNames parámetro . Establecer esta propiedad permite que una MessageQueue instancia de use XmlMessageFormatter para leer mensajes que contienen objetos de tipos especificados.

Tanto las TargetTypeNames propiedades como TargetTypes indican al formateador qué esquemas deben intentar coincidir al deserializar un mensaje. Esto permite al formateador interpretar el cuerpo del mensaje.

La instancia serializada en el cuerpo del mensaje debe cumplir uno de los esquemas representados en la matriz de tipos. Cuando se lee el mensaje mediante el Receive método , el método crea un objeto del tipo que corresponde al esquema identificado y lee el cuerpo del mensaje en él.

Solo es necesario establecer una de las dos propiedades al leer desde la cola, pero puede establecer ambas. El conjunto de tipos es el conjunto combinado de las dos propiedades. La decisión de que se va a usar es específica de la aplicación. Si el cuerpo del mensaje contiene un tipo cuyo esquema no coincide con ninguno de los tipos de la matriz para cualquiera de las propiedades , se producirá una excepción en tiempo de lectura.

Se aplica a

XmlMessageFormatter(Type[])

Inicializa una nueva instancia de la clase XmlMessageFormatter, estableciendo los tipos de destino pasados en forma matriz de tipos de objetos.

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

Parámetros

targetTypes
Type[]

Matriz de tipo Type que especifica el conjunto de tipos posibles que deserializará el formateador a partir del mensaje proporcionado.

Excepciones

ArgumentNullException

El parámetro targetTypes es null.

Comentarios

Los constructores con parámetros de tipo de destino se usan con más frecuencia al leer desde la cola. Al escribir, no es necesario especificar tipos de destino.

Esta sobrecarga del XmlMessageFormatter constructor establece la TargetTypes propiedad en los valores de matriz pasados a través del targetTypes parámetro . Establecer esta propiedad permite que una MessageQueue instancia de use XmlMessageFormatter para leer mensajes que contienen objetos de los tipos especificados.

Tanto las TargetTypeNames propiedades como TargetTypes indican al formateador qué esquemas deben intentar coincidir al deserializar un mensaje. Esto permite al formateador interpretar el cuerpo del mensaje.

La instancia serializada en el cuerpo del mensaje debe cumplir uno de los esquemas representados en la matriz de tipos. Cuando se lee el mensaje mediante el Receive método , el método crea un objeto del tipo que corresponde al esquema identificado y lee el cuerpo del mensaje en él.

Solo es necesario establecer una de las dos propiedades al leer desde la cola, pero puede establecer ambas. El conjunto de tipos es el conjunto combinado de las dos propiedades. La decisión de que se va a usar es específica de la aplicación. Si el cuerpo del mensaje contiene un tipo cuyo esquema no coincide con ninguno de los tipos de la matriz para cualquiera de las propiedades , se producirá una excepción en tiempo de lectura.

Al especificar TargetTypes en lugar de TargetTypeNames, la existencia de tipos se comprueba en tiempo de compilación en lugar de tiempo de lectura, lo que reduce la posibilidad de error. TargetTypeNames requiere que cada entrada esté completa y especifique su nombre de ensamblado. Además, al trabajar con varias versiones simultáneas, el número de versión también debe anexarse al nombre del tipo de destino.

Al usar TargetTypes, puede agregar cada objeto (por ejemplo, MyClass) a la lista de una manera que muestra el código de C# siguiente.

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

Se aplica a