The methods of the TipcMsg class are listed below. For a complete list of TipcMsg class members, see the TipcMsg Members topic.
Public Instance Methods
 ack | Acknowledges the receipt of a message received by Guaranteed Message Delivery. |
| addNamedBinary | Appends a binary field to a message, with a name. |
| addNamedBool | Append a boolean field to a message, with a name. |
| addNamedBoolArray | Append a boolean array field to a message, with a name. |
| addNamedByte | Appends a byte field to a message, with a name. |
| addNamedChar | Overloaded. Appends a character (byte) field to a message, with a name. |
| addNamedGuid | Appends a Globally Unique Identifier to a message, with a name. |
| addNamedGuidArray | Append an array of Globally Unique Identifiers to a message, with a name. |
| addNamedInt2 | Appends a 2 byte integer field to a message, with a name. |
| addNamedInt2Array | Appends a 2 byte integer array field to a message, with a name. |
| addNamedInt4 | Appends a 4 byte integer field to a message, with a name. |
| addNamedInt4Array | Appends 4 byte integer array field to a message, with a name. |
| addNamedInt8 | Appends a 8 byte integer field to a message, with a name. |
| addNamedInt8Array | Appends a 8 byte integer array field to a message, with a name. |
| addNamedMsg | Appends a message field to a message, with a name. |
| addNamedMsgArray | Appends a message array field to a message, with a name. |
| addNamedMsgId | Append a TIBCO message ID to a message, with a name. |
| addNamedMsgIdArray | Append an array of TIBCO message IDs to a message. |
| addNamedObject | Appends an arbitrary .NET Object to the message, with a name. The object will be encoded in a binary field, using the standard serialization mechanism. Therefore, the object passed to this method must implement the Serializable interface. Note that any objects to be serialized must not only themselves be implemented Serializable, but all of the classes they extend must be Serializable. This object will only be useful to receiving clients in .NET. C clients will receive a binary field which may be forwarded to other .NET clients. |
| addNamedReal4 | Appends a 4 byte real field to a message, with a name. |
| addNamedReal4Array | Appends a 4 byte real array field to a message, with a name. |
| addNamedReal8 | Appends a 8 byte real field to a message, with a name. |
| addNamedReal8Array | Appends a 8 byte real array field to a message, with a name. |
| addNamedStr | Appends a string field to a message, with a name. |
| addNamedStrArray | Appends a string array field to a message, with a name. |
| addNamedTimestamp | Append a timestamp field to a message, with a name. |
| addNamedTimestampArray | Append a timestamp array field to a message, with a name. |
| addNamedUnknown | Appends a new named field of the specified type to the message, but marks the field as 'value unknown'. The constants required for the parameter, field_type, are specified in this module (TipcMsg) and can be recognized by their FT_* names. |
| addNamedUtf8 | Append a UTF-8 string field to a message, with a name. |
| addNamedUtf8Array | Append a UTF-8 string array field to a message, with a name. |
| addNamedXml | Appends an XML field to a message, with a name. |
| appendBinary | Overloaded. Appends a binary field to a message. No conversion will occur for binary fields. It is up to the programmer to provide any required conversion. |
| appendBool | Append a boolean field to a message. |
| appendBoolArray | Overloaded. Append a boolean array field to a message. |
| appendByte | Appends a byte field to a message. |
| appendChar | Overloaded. Appends a character field to a message. |
| appendGuid | Append a Globally Unique Identifier to a message. |
| appendGuidArray | Append an array of Globally Unique Identifiers to a message. |
| appendInt2 | Appends a 2 byte integer field to a message. |
| appendInt2Array | Overloaded. Appends a 2 byte integer array field to a message. |
| appendInt4 | Appends a 4 byte integer field to a message. |
| appendInt4Array | Overloaded. Appends a 4 byte integer array field to a message. |
| appendInt8 | Appends a 8 byte integer field to a message. |
| appendInt8Array | Overloaded. Appends a 8 byte integer array field to a message. |
| appendMsg | Appends a message field to a message. |
| appendMsgArray | Overloaded. Appends a message array field to a message. |
| appendMsgId | Append a TIBCO message ID to a message. |
| appendMsgIdArray | Append an array of TIBCO message IDs to a message. |
| appendObject | Appends an arbitrary Object to the message. The object will be encoded in a binary field, using the standard serialization mechanism. Therefore, the object passed to this method must implement the Serializable interface. Note that any objects to be serialized must not only themselves be implemented as Serializable, but all of the classes they extend must be Serializable. This object will only be useful to receiving clients in .NET, C/C++/Java clients will receive a binary field which may be forwarded to other .NET clients. |
| appendReal4 | Appends a 4 byte real field to a message. |
| appendReal4Array | Overloaded. Appends a 4 byte real array field to a message. |
| appendReal8 | Appends a 8 byte real field to a message. |
| appendReal8Array | Overloaded. Appends a 8 byte real array field to a message. |
| appendStr | Appends a string field to a message.
For C/C++ clients, this field will represent ASCII characters only.
To send Unicode strings to C/C++ clients use appendUtf8.
|
| appendStrArray | Overloaded. Appends a string array field to a message.
For C/C++ clients, this field will represent ASCII characters only.
To send Unicode strings to C/C++ clients use appendUtf8Array.
|
| appendTimestamp | Append a timestamp field to a message. |
| appendTimestampArray | Append an array of timestamps to a message. |
| appendUnknown | Appends a new field of the specified type to the message, but
marks the field as an 'unknown value'. The constants required for
the parameter, field_type, are specified in this class and
can be recognized by their FT_* names.
|
| appendUtf8 | Append a UTF-8 string field to a message. The String
will be converted to UTF-8 prior to being appended to the message.
|
| appendUtf8Array | Overloaded. Append an array of UTF-8 strings to a message. The String's
will be converted to UTF-8 prior to being appended to the message.
|
| appendXml | Appends an XML field to a message. |
| Clone | Clones the message. |
| deleteCurrent | Deletes current field in a message. |
| deleteField | Deletes the specified field in a message. |
| deleteNamedField | Deletes a named field in a message. |
| deleteProp | Implementation of public interface method. |
| destroy | Destroys the message. If the message was received using GMD, this will also acknowledge the message. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| existsNamed | Returns true if there is a field by the given field name, false if not. |
| generateMessageId | Generates the message id property for the message. A message id will uniquely identify each message sent by a publisher. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. |
| getNamedBinary | Returns the binary field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedBool | Returns a boolean field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedBoolArray | Returns a boolean array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedByte | Returns the byte field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedChar | Returns the character field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedCharByte | Returns the character field corresponding to the given field name as a byte. If there is no field by that name, an exception will be thrown. |
| getNamedFieldKnown | Examines the named field and reports back if it is an actual value, or a field marked as having an 'unknown value'. Does not advance to the next field. |
| getNamedGuid | Returns Guid field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedGuidArray | Returns Guid Array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt2 | Returns a 2 byte integer field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt2Array | Returns a 2 byte integer array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt4 | Returns a 4 byte integer field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt4Array | Returns a 4 byte integer array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt8 | Returns a 8 byte integer field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedInt8Array | Returns a 8 byte integer array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedMsg | Returns message field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedMsgArray | Returns message array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedMsgId | Returns MsgId field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedMsgIdArray | Returns MsgId Array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedObject | Returns Object field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedReal4 | Returns a 4 byte real field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedReal4Array | Returns a 4 byte real array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedReal8 | Returns a 8 byte real field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedReal8Array | Returns a 8 byte real array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedStr | Returns string field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedStrArray | Returns string array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedTimestamp | Returns a timestamp field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedTimestampArray | Returns a timestamp array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedUnknown | Returns true if the field corresponding to the given field name is marked as having 'unknown value'. If the field has a 'known value' a TipcMsgBadFieldException will be thrown. If there is no field by that name, an exception will be thrown. |
| getNamedUtf8 | Returns a UTF-8 string field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedUtf8Array | Returns a UTF-8 string array field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| getNamedXml | Returns an XML field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| getTypeNamed | Returns the type of the field corresponding to the given field name. If there is no field by that name, an exception will be thrown. |
| log | Logs the message to the stream. |
| nextBinary | Overloaded. Gets a binary field from the message. |
| nextBool | Gets a boolean field from the message. |
| nextBoolArray | Overloaded. Gets a boolean array from the message. |
| nextByte | Gets a byte field from the message. |
| nextChar | Gets a character field from the message. |
| nextCharByte | Gets a character field as a byte from the message. |
| nextGuid | Gets a Globally Unique Identifer from the message. |
| nextGuidArray | Overloaded. Gets an array of Globally Unique Identifers from the message. |
| nextInt2 | Gets a 2 byte integer field from the message. |
| nextInt2Array | Overloaded. Gets a 2 byte integer array from the message. |
| nextInt4 | Gets a 4 byte integer field from the message. |
| nextInt4Array | Overloaded. Gets a 4 byte integer array from the message. |
| nextInt8 | Gets a 8 byte integer field from the message. |
| nextInt8Array | Overloaded. Gets a 8 byte integer array from the message. |
| nextMsg | Gets a message field from the message. |
| nextMsgArray | Overloaded. Gets a message array from the message. |
| nextMsgId | Gets a TIBCO message ID from the message. |
| nextMsgIdArray | Overloaded. Gets an array of TIBCO message IDs from the message. |
| nextObject | Decodes the next field (which must be a binary field) as an arbitrary .NET Object. Objects encoded into a binary field with the appendObject method are decoded with this method. Decoding objects carries the same restrictions as the standard .NET serialization mechanism. Serialized objects must implement the Serializable interface. |
| nextReal4 | Gets a 4 byte real field from the message. |
| nextReal4Array | Overloaded. Gets a 4 byte real array from the message. |
| nextReal8 | Gets a 8 byte real field from the message. |
| nextReal8Array | Overloaded. Gets a 8 byte real array from the message. |
| nextStr | Gets a string field from the message. |
| nextStrArray | Overloaded. Gets a string array from the message. |
| nextTimestamp | Gets a timestamp field from the message. |
| nextTimestampArray | Gets a timestamp array from the message. |
| nextType | Gets the type (FT_*) of the next field.
|
| nextUnknown | If the next field in the message is marked as an 'unknown value', this method will skip over the field and return true. If the field has a 'known value', the current field will not be advanced, and a TipcMsgBadFieldException will be thrown. |
| nextUtf8 | Gets a UTF-8 string field from the message. |
| nextUtf8Array | Overloaded. Gets a UTF-8 string array field from the message. |
| nextXml | Implementation of public interface method. |
| print | Overloaded. Prints the message to the SmartSockets "standard" output stream. Prints the message in human readable form, showing the value of all user-settable fields as well as all data currently in the message. |
| setPropBinary | Set a message property as a partial binary field. Use of this method is strongly discouraged. It is intended for TIBCO internal use, and is subject to arbitrary changes. |
| setPropInt | Set a message property as an integer. Use of this method is strongly discouraged. It is intended for TIBCO internal use, and is subject to arbitrary changes. |
| setPropShort | Set a message property as a short. Use of this method is strongly discouraged. It is intended for TIBCO internal use, and is subject to arbitrary changes. |
| setPropStr | Set a message property as a string. Use of this method is strongly discouraged. It is intended for TIBCO internal use, and is subject to arbitrary changes. |
| setPropStrArray | Set a message property as a partial string array. Use of this method is strongly discouraged. It is intended for TIBCO internal use, and is subject to arbitrary changes. |
| toByteArray | Serializes the contents of the current message into a byte array. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| updateNamedBinary | Updates a named binary field in a message. |
| updateNamedBool | Updates a named bool field in a message. |
| updateNamedBoolArray | Updates a named bool array field in a message. |
| updateNamedByte | Updates a named byte field in a message. |
| updateNamedChar | Overloaded. Updates a named character (byte) field in a message. |
| updateNamedGuid | updates a Globally Unique Identifier to a message, with a name. |
| updateNamedGuidArray | Update an array of Globally Unique Identifiers to a message, with a name. |
| updateNamedInt2 | Updates a named 2 byte integer field in a message. |
| updateNamedInt2Array | Updates a named 2 byte integer array field in a message. |
| updateNamedInt4 | Updates a named 4 byte integer field in a message. |
| updateNamedInt4Array | Updates a named 4 byte integer array field in a message. |
| updateNamedInt8 | Updates a named 8 byte integer field in a message. |
| updateNamedInt8Array | Updates a named 8 byte integer array field in a message. |
| updateNamedMsg | Updates a named message field in a message. |
| updateNamedMsgArray | Updates a named message array field in a message. |
| updateNamedMsgId | Updates a named TIBCO message ID field in a message. |
| updateNamedMsgIdArray | Update a named TIBCO message ID array field in a message. |
| updateNamedObject | Updates a named arbitrary .NET Object in the message. The object will be encoded in a binary field, using the standard serialization mechanism. Therefore, the object passed to this method must implement the Serializable interface. Note that any objects to be serialized must not only themselves implemented Serializable, but all of the classes they extend must be Serializable. This object will only be useful to receiving clients in .NET C clients will receive a binary field which may be forwarded to other .NET clients. |
| updateNamedReal4 | Updates a named 4 byte real field in a message. |
| updateNamedReal4Array | Updates a named 4 byte real array field in a message. |
| updateNamedReal8 | Updates a named 8 byte real field in a message. |
| updateNamedReal8Array | Updates a named 8 byte real array field in a message. |
| updateNamedStr | Updates a named string field in a message. |
| updateNamedStrArray | Updates a named string array field in a message. |
| updateNamedTimestamp | Updates a named timestamp field in a message. |
| updateNamedTimestampArray | Updates a named timestamp array field in a message. |
| updateNamedUtf8 | Updates a named Utf8 field in a message. |
| updateNamedUtf8Array | Updates a named Utf8Array field in a message. |
| updateNamedXml | Updates a named XML field in a message. |
Protected Instance Methods
 Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
See Also
TipcMsg Class | TIBCO.SMARTSOCKETS Namespace
Copyright © TIBCO Software Inc. All rights reserved