WebSphere Message Broker™ V8.0.0.0 .NET Plugin Node API
NBMessage Class
NamespacesIBM.Broker.PluginNBMessage
SUMMARY
NBMessage represents the message passed between the nodes in a message flow. A message in its raw form is a sequence of bytes known as the wire format.
Declaration Syntax
C#Visual BasicVisual C++F#
public class NBMessage : IDisposable
Public Class NBMessage _
	Implements IDisposable
public ref class NBMessage : IDisposable
type NBMessage =  
    class
        interface IDisposable
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
NBMessage(NBMessage)
A copy constructor for an NBMessage. An new NBMessage is constructed based on a deep copy of the existing message passed in.

NBMessage()()()()
The default constructor for an NBMessage.

Dispose()()()()
Deletes the resources associated with the message.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FinalizeMessage()()()()
Performs finalizing processing on the message.

GetBuffer()()()()
Gets a copy of the data buffer associated with (and owned by) the message object.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
ReadOnly
Returns true if the message is read only.

RootElement
Returns the RootNBElement of the message.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
Nodes within the broker will navigate and manipulate the message using a logical format whereby the message is represented as a hierarchical tree of NBElements.

Conversion between these two formats is managed by parsers. Different parsers are invoked by the root parser as required during the parsing of a message. The following diagram shows a typical message.


                  +------+
                  | Root |
                  +------+
                 /        
                /          \ 
               /            \  
              /              \   
             /                \    
    +----------+    +----+    +------+
    |Properties|----|MQMD|----|XMLNSC|
    +----------+    +----+    +------+

The root parser at the top will invoke the parsers along the bottom in the order shown to parse the bit stream into a tree. This tree will then have same structure as shown in the diagram with sub-trees off each parser element representing its part of the message. For example the MQMD header is the first sibling of the first child of Root and the MQMD fields are children of this.

The element representing the root is returned by the property RootElement. This is an object of type NBElement which contains methods to navigate and modify the tree.

Also, see the topic "Working with Messages. Appendix A: Message Parsers - element definitions" in the Infocenter.

Warning: caching NBMessage objects over multiple message flow invocations is unsupported because the internal state may be reset at the end of each message flow invocation.

Inheritance Hierarchy

Assembly: IBM.Broker.Plugin (Module: IBM.Broker.Plugin) Version: 8.0.0.0