Open topic with navigation

TIBCO Rendezvous® 8.7.0

# Message

Class

## Superclasses

    System.Object
      Message

## Visual Basic

    Public Class Message

## C#

    public class Message

## Purpose

Represent Rendezvous messages.

## Remarks

This class has no `destroy()` method. Instead, the garbage collector reclaims storage automatically. Nonetheless it is possible to explicitly manage native message storage; see Message.Dispose().

Method | Description | Page
## Message Life Cycle and Properties
Message | Create a message object. | Message
Message.Dispose() | Release native storage associated with the message. | Message.Dispose()
## Fields
Message.AddField | Add a field to a message. | Message.AddField
Message.AddStringAsXml | Add a string to a message as the value of an XML field (without parsing it to verify that it specifies a well-formed XML document). | Message.AddStringAsXml
Message.Expand | Enlarge a message by allocating additional storage. | Message.Expand
Message.GetField | Get a specified field from a message. | Message.GetField
Message.GetFieldByIndex | Get a field from a message by an index. | Message.GetFieldByIndex
Message.GetFieldInstance | Get a specific instance of a field from a message. | Message.GetFieldInstance
Message.GetXmlAsString ``Message.GetXmlAsStringByIndex()`` | Get an XML field from a message, and return its value as a string (without parsing to verify that it specifies a well-formed XML document). | Message.GetXmlAsString
Message.RemoveField | Remove a field from a message. | Message.RemoveField
Message.RemoveFieldInstance | Remove a specified instance of a field from a message. | Message.RemoveFieldInstance
Message.Reset | Clear a message, preparing it for re-use. | Message.Reset
Message.ToByteArray | Extract the data from a message as a byte sequence. | Message.ToByteArray
Message.UpdateField | Update a field within a message. | Message.UpdateField
## Message Dispatched
Message.GetSource | Extract the source associated with a (dispatched) message object. | Message.GetSource
## Custom Datatypes (Static Method)
Message.RegisterCustomDataType | Register a custom datatype for automatic encoding and decoding. | Message.RegisterCustomDataType

Member | Description |
## Public Instance Properties
``FieldCount`` | ``uint`` The number of fields in the message. This count includes only the immediate fields of the message; it does not include fields within recursive submessages. | Get
``FieldCountAsInt`` | ``int`` Identical to FieldCount, except its type is `int`. (`for` loops in Visual Basic .NET require `int` parameters.) | Get
``ReplySubject`` | ``string`` The reply subject of the message. For more information, see Subjects. | Get Set
``SendSubject`` | ``string`` The destination subject of the message. When this property is null, the message is unsendable. For more information, see Subjects. | Get Set
``Size`` | ``uint`` The size of the message (in bytes). | Get
## Public Static Fields
``MinimumCustomDataTypeID````MaximumCustomDataTypeID`` | ``byte`` Type designators of custom datatypes must be in the inclusive range defined by these two constants—that is:
    [MinimumCustomDataTypeIDMaximumCustomDataTypeID, MinimumCustomDataTypeIDMaximumCustomDataTypeID]

## Subjects

Rendezvous routing daemons modify message subjects and reply subjects to enable transparent point-to-point communication across network boundaries. This modification does not apply to subject names stored in within message data fields; we discourage storing point-to-point subject names in data fields.

Subjects and reply subjects are parts of a message’s address information—they are not part of the message itself; see also Supplementary Information for Messages in TIBCO Rendezvous Concepts.

## See Also

Strings and Character Encodings

MessageField

Subtopics

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Rendezvous®

Copyright © 1997-2023. Cloud Software Group, Inc. All Rights Reserved.