The properties of the TipcMsg class are listed below. For a complete list of TipcMsg class members, see the TipcMsg Members topic.
Public Instance Properties
 ArrivalTimestamp | Gets/Sets the arrival timestamp property of the message. Returns the timestamp of the message in seconds since 00:00:00 UTC, January 1, 1970, or 0.0 if not set |
| Compression | Gets/Sets the compression flag. True to enable compression. |
| CorrelationId | Gets/Sets the correlation id property of the message. Returns the message id of the message or null if not set. |
| Current | Gets/Sets the current field number of the message. The "current field" is a cursor indexing the fields in a message. |
| CurrentFieldCharFormat | Gets the character format for the current field. The char format, which will be one of CHAR_US_ASCII or CHAR_US_EBCDIC |
| CurrentFieldIntFormat | Gets the integer format for the current field. The int format, which will be one of INT_LITTLE_ENDIAN or INT_BIG_ENDIAN |
| CurrentFieldKnown | Returns true if the current field contains an actual value; false if the field is marked as having an 'unknown value'. |
| CurrentFieldRealFormat | Gets the real format for the current field. The real format, which will be one of REAL_DEC_G, REAL_DEC_D, REAL_IEEE, or REAL_370 |
| DeliveryMode | Gets/Sets the GMD delivery mode of the message. The delivery mode is one of: DELIVERY_BEST_EFFORT, DELIVERY_ORDERED, DELIVERY_SOME, or DELIVERY_ALL. |
| DeliveryTimeout | Gets/Sets the delivery timeout property of the message. The delivery timeout determines how long the client will wait for a GMD acknowledgement before deciding that a failure has occurred. |
| Dest | Gets/Sets the destination property of the message. The destination property is the subject this message is being published to. It has no meaning in peer-to-peer connections. |
| Enumerator | Returns a TipcMsgEnumerator for this message object. |
| Expiration | Gets/Sets the expiration property of the message. Returns the message time-to-live value in seconds |
| LbMode | Gets/Sets the load balancing mode of the message. The load balancing mode is one of: LB_NONE, LB_ROUND_ROBIN, LB_WEIGHTED, or LB_SORTED. |
| MessageId | Gets the message id property of the message.
A message id will uniquely identify each message sent by a publisher.
Returns the message id of the message or null if not set
|
| MonitorId | Monitor ID. |
| NameCurrent | Gets/Sets the name of the current field. Appending a new field does not advance the current field index, so you must manually set the current field after appending a field to a message. |
| NumFields | Gets/Sets the number of fields in the message. When the number of fields is set and the number is smaller than the actual number of fields, the extra fields will be removed. |
| PacketSize | Gets the packet size (in bytes) of the message. |
| Priority | Gets/Sets the priority of the message. |
| ReadOnly | Gets the read-only property of the message. A message is "read-only" if it is embedded as a message-within-a-message. You may not append new fields to a read-only message, and you may not set this property. |
| ReplyTo | Gets/Sets the reply to subject property of the message.
Returns the reply to subject or null if not set
|
| Sender | Gets/Sets the sender property of the message. The sender property identifies the sending client. By default, this is set to the unique subject of the client. For RTserver connections, this property is forced to the sender's unique subject, regardless of the setting of this property. |
| SenderTimestamp | Gets/Sets the sender timestamp property of the message. Returns the timestamp of the message in seconds since 00:00:00 UTC, January 1, 1970, or 0.0 if not set |
| SeqNum | Gets/Sets the sequence number property of the message. |
| StreamID | Gets/Sets the source ordered delivery stream ID property of the message. |
| Type | Gets/Sets the message type of the message. Returns the message type of the message Note: that any default properties of the new message type do NOT affect this message's properties when this method is used to set the message type. |
| UserProp | Gets/Sets the user property of the message. The user property is any arbitrary value (int) the user assigns. |
See Also
TipcMsg Class | TIBCO.SMARTSOCKETS Namespace
Copyright © TIBCO Software Inc. All rights reserved