Any suggestions? Export (0) Print
Expand All

Message Class

 

Provides access to the properties needed to define a Message Queuing message.

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

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Messaging.Message

Public Class Message
	Inherits Component

NameDescription
System_CAPS_pubmethodMessage()

Initializes a new instance of the Message class with an empty body.

System_CAPS_pubmethodMessage(Object)

Initializes a new instance of the Message class, using the XmlMessageFormatter to serialize the specified object into the body of the message.

System_CAPS_pubmethodMessage(Object, IMessageFormatter)

Initializes a new instance of the Message class using the specified formatter to serialize the specified object into the body of the message.

NameDescription
System_CAPS_pubpropertyAcknowledgeType

Gets or sets the type of acknowledgment message to be returned to the sending application.

System_CAPS_pubpropertyAcknowledgment

Gets the classification of acknowledgment that this message represents.

System_CAPS_pubpropertyAdministrationQueue

Gets or sets the queue that receives the acknowledgement messages that Message Queuing generates.

System_CAPS_pubpropertyAppSpecific

Gets or sets additional, application-specific information.

System_CAPS_pubpropertyArrivedTime

Gets the time that the message arrived in the destination queue.

System_CAPS_pubpropertyAttachSenderId

Gets or sets a value that indicates whether the sender ID should be attached to the message.

System_CAPS_pubpropertyAuthenticated

Gets a value that indicates whether the message was authenticated.

System_CAPS_pubpropertyAuthenticationProviderName

Gets or sets the name of the cryptographic provider used to generate the digital signature of the message.

System_CAPS_pubpropertyAuthenticationProviderType

Gets or sets the type of cryptographic provider used to generate the digital signature of the message.

System_CAPS_pubpropertyBody

Gets or sets the content of the message.

System_CAPS_pubpropertyBodyStream

Gets or sets the information in the body of the message.

System_CAPS_pubpropertyBodyType

Gets or sets the type of data that the message body contains.

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyConnectorType

Gets or sets a value that indicates that some message properties typically set by Message Queuing were set by the sending application.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyCorrelationId

Gets or sets the message identifier used by acknowledgment, report, and response messages to reference the original message.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_pubpropertyDestinationQueue

Gets the intended destination queue for a message.

System_CAPS_pubpropertyDestinationSymmetricKey

Gets or sets the symmetric key used to encrypt application-encrypted messages or messages sent to foreign queues.

System_CAPS_pubpropertyDigitalSignature

Gets or sets the digital signature that Message Queuing uses to authenticate the message.

System_CAPS_pubpropertyEncryptionAlgorithm

Gets or sets the encryption algorithm used to encrypt the body of a private message.

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyExtension

Gets or sets additional, application-defined information associated with the message.

System_CAPS_pubpropertyFormatter

Gets or sets the formatter used to serialize an object into or deserialize an object from the message body.

System_CAPS_pubpropertyHashAlgorithm

Gets or sets the hashing algorithm that Message Queuing uses when authenticating a message or creating a digital signature for a message.

System_CAPS_pubpropertyId

Gets the message's identifier.

System_CAPS_pubpropertyIsFirstInTransaction

Gets a value that indicates whether the message was the first message sent in a transaction.

System_CAPS_pubpropertyIsLastInTransaction

Gets a value that indicates whether the message was the last message sent in a transaction.

System_CAPS_pubpropertyLabel

Gets or sets an application-defined Unicode string that describes the message.

System_CAPS_pubpropertyLookupId

Introduced in MSMQ 3.0. Gets the message's lookup identifier.

System_CAPS_pubpropertyMessageType

Gets the message type: Normal, Acknowledgment, or Report.

System_CAPS_pubpropertyPriority

Gets or sets the message priority, which determines where in the queue the message is placed.

System_CAPS_pubpropertyRecoverable

Gets or sets a value that indicates whether the message is guaranteed to be delivered in the event of a computer failure or network problem.

System_CAPS_pubpropertyResponseQueue

Gets or sets the queue that receives application-generated response messages.

System_CAPS_pubpropertySecurityContext

Gets or sets the security context for a message.

System_CAPS_pubpropertySenderCertificate

Gets or sets the security certificate used to authenticate messages.

System_CAPS_pubpropertySenderId

Gets the identifier of the sending user.

System_CAPS_pubpropertySenderVersion

Gets the version of Message Queuing used to send the message.

System_CAPS_pubpropertySentTime

Gets the date and time on the sending computer that the message was sent by the source queue manager.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertySourceMachine

Gets the computer from which the message originated.

System_CAPS_pubpropertyTimeToBeReceived

Gets or sets the maximum amount of time for the message to be received from the destination queue.

System_CAPS_pubpropertyTimeToReachQueue

Gets or sets the maximum amount of time for the message to reach the queue.

System_CAPS_pubpropertyTransactionId

Gets the identifier for the transaction of which the message was a part.

System_CAPS_pubpropertyTransactionStatusQueue

Gets the transaction status queue on the source computer.

System_CAPS_pubpropertyUseAuthentication

Gets or sets a value that indicates whether the message was (or must be) authenticated before being sent.

System_CAPS_pubpropertyUseDeadLetterQueue

Gets or sets a value that indicates whether a copy of the message that could not be delivered should be sent to a dead-letter queue.

System_CAPS_pubpropertyUseEncryption

Gets or sets a value that indicates whether to make the message private.

System_CAPS_pubpropertyUseJournalQueue

Gets or sets a value that indicates whether a copy of the message should be kept in a machine journal on the originating computer.

System_CAPS_pubpropertyUseTracing

Gets or sets a value that indicates whether to trace a message as it moves toward its destination queue.

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_protmethodMemberwiseClone(Boolean)

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

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticInfiniteTimeout

Specifies that no time-out exists.

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Use the Message class to peek or receive messages from a queue, or to have fine control over message properties when sending a message to a queue.

MessageQueue uses the Message class when it peeks or receives messages from queues, because both the MessageQueue.Peek and MessageQueue.Receive methods create a new instance of the Message class and set the instance's properties. The Message class's read-only properties apply to retrieving messages from a queue, while the read/write properties apply to sending and retrieving messages. When MessageQueue peeks or receives a message from a queue, its MessageReadPropertyFilter property determines which of the message's properties are retrieved.

The MessageQueue class's Send method allows you to specify any object type for a message being sent to that queue. You can use the MessageQueue instance's DefaultPropertiesToSend property to specify settings for generic messages sent to the queue. The types of settings include formatter, label, encryption, and authentication. You can also specify values for the appropriate DefaultPropertiesToSend members when you coordinate your messaging application to respond to acknowledgment and report messages. Using a Message instance to send a message to the queue gives you the flexibility to access and modify many of these properties—either for a single message or on a message-by-message basis. Message properties take precedence over DefaultPropertiesToSend.

Message data is stored in the Body property and to a lesser extent, the AppSpecific and Extension properties. When message data is encrypted, serialized, or deserialized, only the contents of the Body property are affected.

The contents of the Body property are serialized when the message is sent, using the Formatter property you specify. The serialized contents are found in the BodyStream property. You can also set the BodyStream property directly, for example, to send a file as the data content of a message. You can change the Body or Formatter properties at any time before sending the message, and the data will be serialized appropriately when you call Send.

The properties defined by the MessageQueue.DefaultPropertiesToSend property apply only to messages that are not of type Message. If you specify the DefaultPropertiesToSend property for a MessageQueue, the identically named properties in a Message instance sent to that queue cause these default properties to be ignored.

For a list of initial property values for an instance of Message, see the Message constructor.

The following code example demonstrates formatting a message body using BinaryMessageFormatter.

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

The following code example demonstrates formatting a message body using XmlMessageFormatter.

Imports System
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 'Order



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




      ' 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 'ReceiveMessage
End Class 'MyNewQueue

.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:
© 2016 Microsoft