This documentation is archived and is not being maintained.

BinaryMessageFormatter Class

Serializes or deserializes an object, or an entire graph of connected objects, to or from the body of a Message Queuing message, using a binary format.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

'Declaration
Public Class BinaryMessageFormatter _
	Implements IMessageFormatter, ICloneable
'Usage
Dim instance As BinaryMessageFormatter

The BinaryMessageFormatter is very efficient and can be used to serialize most objects. The result is very compact and fast to parse, but does not allow for loosely coupled messaging as the XmlMessageFormatter does. Loosely coupled means that the client and the server can independently version the type that is sent and received.

When the application sends a message to the queue using an instance of the MessageQueue class, the formatter serializes the object into a stream and inserts it into the message body. When reading from a queue using a MessageQueue, the formatter deserializes the message data into the Body property of a Message.

BinaryMessageFormatter provides faster throughput than the XmlMessageFormatter. Use the BinaryMessageFormatter when pure speed rather than loosely coupled messaging is desired.

Imports System
Imports System.Messaging
Imports System.Drawing
Imports System.IO


Namespace MyProj
    _


   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 'Main


      '************************************************** 
      ' 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 'CreateQueue


      '************************************************** 
      ' Sends an image to a queue, using the BinaryMessageFormatter. 
      '************************************************** 
      Public Sub SendMessage()
         Try 

            ' Create a new bitmap. 
            ' The file must be in the \bin\debug or \bin\retail folder, or 
            ' you must give a full path to its location. 
            Dim myImage As Image = Bitmap.FromFile("SentImage.bmp")

            ' Connect to a queue on the local computer. 
            Dim myQueue As New MessageQueue(".\myQueue")

            Dim myMessage As New Message(myImage, New BinaryMessageFormatter())

            ' Send the image to the queue.
            myQueue.Send(myMessage)
         Catch e As ArgumentException
            Console.WriteLine(e.Message)
         End Try  

         Return 
      End Sub 'SendMessage



      '************************************************** 
      ' Receives a message containing an image. 
      '************************************************** 
      Public Sub ReceiveMessage()

         Try 

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

            ' Receive and format the message.  
            Dim myMessage As System.Messaging.Message = myQueue.Receive()
            Dim myImage As Bitmap = CType(myMessage.Body, Bitmap)

            ' This will be saved in the \bin\debug or \bin\retail folder.
            myImage.Save("ReceivedImage.bmp", System.Drawing.Imaging.ImageFormat.Bmp)



         'Catch 
         ' Handle Message Queuing exceptions. 

         ' Handle invalid serialization format. 
         Catch e As InvalidOperationException
            Console.WriteLine(e.Message)

         Catch e As IOException
         End Try 
         ' Handle file access exceptions. 

         ' Catch other exceptions as necessary. 
         Return 
      End Sub 'ReceiveMessage
   End Class 'MyNewQueue
End Namespace 'MyProj
#using <mscorlib.dll>
#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;

/// <summary>
/// Provides a container class for the example.
/// </summary>
__gc class MyNewQueue 
{
	//*************************************************
	// Creates a new queue.
	//*************************************************
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);
		}

	}

	//*************************************************
	// Sends an image to a queue, using the BinaryMessageFormatter.
	//*************************************************
public:
	void SendMessage() 
	{
		try 
		{
			// Create a new bitmap.
			// The file must be in the \bin\debug or \bin\retail folder, or
			// you must give a full path to its location.
			Image* myImage = Bitmap::FromFile(S"SentImage::bmp");

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

			Message* myMessage = new Message(myImage, new BinaryMessageFormatter());

			// Send the image to the queue.
			myQueue->Send(myMessage);
		} 
		catch (ArgumentException* e) 
		{
			Console::WriteLine(e->Message);
		}

		return;
	}

	//*************************************************
	// Receives a message containing an image.
	//*************************************************
public:
	void ReceiveMessage() 
	{
		try 
		{
			// Connect to the a queue on the local computer.
			MessageQueue* myQueue = new MessageQueue(S".\\myQueue");

			// Set the formatter to indicate body contains an Order.
			myQueue->Formatter = new BinaryMessageFormatter();

			// Receive and format the message. 
			Message* myMessage = myQueue->Receive(); 
			Bitmap* myImage = static_cast<Bitmap*>(myMessage->Body);

			// This will be saved in the \bin\debug or \bin\retail folder.
			myImage->Save(S"ReceivedImage::bmp", System::Drawing::Imaging::ImageFormat::Bmp);
		} 
		catch (MessageQueueException*) 
		{
			// Handle Message Queuing exceptions.
		}

		// Handle invalid serialization format.
		catch (InvalidOperationException* e) 
		{
			Console::WriteLine(e->Message);
		}
		catch (IOException* e) 
		{
			// Handle file access exceptions.
		}

		// Catch other exceptions as necessary.
		return;
	}
};

//*************************************************
// Provides an entry point into the application.
//         
// This example sends and receives a message from
// a queue.
//*************************************************
int main() 
{
	// Create a new instance of the class.
	MyNewQueue* myNewQueue = new MyNewQueue();

	// Create a queue on the local computer.
	MyNewQueue::CreateQueue(S".\\myQueue");

	// Send a message to a queue.
	myNewQueue->SendMessage();

	// Receive a message from a queue.
	myNewQueue->ReceiveMessage();

	return 0;
}

System.Object
  System.Messaging.BinaryMessageFormatter

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: