TibrvMsgView.extract()
Method
Declaration
static TibrvMsgViewextract(TibrvMsg message)
throws TibrvException
Purpose
Extract a snapshot view of a TIBCO Rendezvous message.
Remarks
This static method parses a snapshot of the native C message into a view of the message data. Upon successful completion, all the message data are available as Java objects.
The message view contains snapshot data. That is, subsequently modifying the data in the message does not affect the data in the message view.
|
Parameter |
Description |
|
|
Extract the data from this message into a new view object. |
Submessages
When a field contains a submessage, this method creates a copy of the submessage—that is, a Java message object corresponding to a an independent copy of the submessage in the C environment. You may access its fields as a message object, or you may explicitly extract the submessage into its own message view.
Decoding and Type Conversion
The method TibrvMsgView.extract() automatically decodes the extracted field data from its Rendezvous wire format type to a corresponding Java type. In Wire Format to Java Datatype Conversion Matrix, filled circles (as well as + and - symbols) specify default decodings between homologous types; for some types you can override the default decoding by using convenience calls that force specific types (see Get Scalar from TibrvMsgView).
Java does not admit unsigned integers. When extracting an unsigned integer from an inbound message field, this method automatically promotes the value to the corresponding Java type that is large enough to contain it (Wire Format to Java Datatype Conversion Matrix indicates this with +). When extracting an unsigned 64-bit integer, Java does not have a type that can contain a number that uses all 64 bits; this method decodes it to a Java long, interpreting the high bit as a sign bit (Wire Format to Java Datatype Conversion Matrix indicates this with -).