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)

System.Object
  System.Messaging.BinaryMessageFormatter

Public Class BinaryMessageFormatter
	Implements IMessageFormatter, ICloneable

NameDescription
System_CAPS_pubmethodBinaryMessageFormatter()

Initializes a new instance of the BinaryMessageFormatter class without specifying a type style or top object assembly style.

System_CAPS_pubmethodBinaryMessageFormatter(FormatterAssemblyStyle, FormatterTypeStyle)

Initializes a new instance of the BinaryMessageFormatter class, specifying the formats of the root object and the type descriptions.

NameDescription
System_CAPS_pubpropertyTopObjectFormat

Gets or sets a value that defines how the top (root) object of a graph is deserialized with regards to finding and loading its assembly.

System_CAPS_pubpropertyTypeFormat

Gets or sets a value that defines how type descriptions are laid out in the serialized stream.

NameDescription
System_CAPS_pubmethodCanRead(Message)

Determines whether the formatter can deserialize the contents of the message.

System_CAPS_pubmethodClone()

Creates an instance of the BinaryMessageFormatter class whose read/write properties (the root object and type description formats) are the same as the current BinaryMessageFormatter.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRead(Message)

Reads the contents from the given message and creates an object that contains the deserialized message.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Message, Object)

Serializes an object into the body of the message.

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)



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

.NET Framework
Available since 1.1

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

Return to top
Show: