TibrvMsg

Class

Declaration

class com.tibco.tibrv.TibrvMsg
  extends java.lang.Object

Purpose

Represent Rendezvous messages.

Remarks

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

Method

Description

Message Life Cycle and Properties

TibrvMsg()

Create a message object.

TibrvMsg.dispose()

Release native storage associated with the message.

TibrvMsg.getNumFields()

Extract the number of fields in a message.

Fields

TibrvMsg.add()

Add a field to a message.

Add Scalar (convenience methods)

Add a field containing a scalar value.

TibrvMsg.addField()

Add a field object to a message.

TibrvMsg.get()

Get the value of a specified field from a message.

Get Scalar (convenience methods)

Get the value of a field as a scalar value.

TibrvMsg.getAsBytes()

Extract the data from a message as a byte sequence.

TibrvMsg.getField()

Get a specified field from a message.

TibrvMsg.getFieldByIndex()

Get a field from a message by an index.

TibrvMsg.getFieldInstance()

Get a specific instance of a field from a message.

TibrvMsg.removeField()

Remove a field from a message.

TibrvMsg.removeFieldInstance()

Remove a specified instance of a field from a message.

TibrvMsg.update()

Update a field within a message.

Update Scalar (convenience methods)

Update a field containing a scalar value.

TibrvMsg.updateField()

Update a field within a message.

Address Information

TibrvMsg.getReplySubject()

Extract the reply subject from a message.

TibrvMsg.getSendSubject()

Extract the subject from a message.

TibrvMsg.setReplySubject()

Set the reply subject for a message.

TibrvMsg.setSendSubject()

Set the subject for a message.

Event Dispatched

TibrvMsg.getEvent()

Extract the event associated with a (dispatched) message object.

String and Character Conversion

TibrvMsg.getTypeName()

Convert a type designator to its corresponding string name.

TibrvMsg.toString()

Format a message as a string.

TibrvMsg.getStringEncoding()

Return the character encoding for converting between Java Strings and wire format strings.

TibrvMsg.setStringEncoding()

Set the character encoding for converting between Java Unicode strings and wire format strings.

Custom Datatypes

See Custom Datatypes.

TibrvMsg.getDecoder()

Extract the decoder interface for a custom datatype.

TibrvMsg.getEncoder()

Extract the encoder interface for a custom datatype.

TibrvMsg.setHandlers()

Define a custom datatype by registering its encoder and decoder interfaces.

Inherited Methods

java.lang.Object.equals

java.lang.Object.getClass

java.lang.Object.hashCode

java.lang.Object.notify

java.lang.Object.notifyAll

java.lang.Object.wait

Datatype Constants

These constants are all defined with short values. To extract a human-readable name from a short value, see TibrvMsg.getTypeName()

Datatype Constants

Constant

Comment

TibrvMsg.DEFAULT

Used only as a type argument to TibrvMsg.add()

TibrvMsg.MSG

 

TibrvMsg.DATETIME

 

TibrvMsg.OPAQUE

 

TibrvMsg.STRING

 

TibrvMsg.XML

Byte-array, compressed for network transmission.

TibrvMsg.BOOL

 

TibrvMsg.I8

 

TibrvMsg.U8

 

TibrvMsg.I16

 

TibrvMsg.U16

 

TibrvMsg.I32

 

TibrvMsg.U32

 

TibrvMsg.I64

 

TibrvMsg.U64

 

TibrvMsg.F32

 

TibrvMsg.F64

 

TibrvMsg.IPPORT16

 

TibrvMsg.IPADDR32

 

TibrvMsg.U8ARRAY

 

TibrvMsg.I16ARRAY

 

TibrvMsg.U16ARRAY

 

TibrvMsg.I32ARRAY

 

TibrvMsg.U32ARRAY

 

TibrvMsg.I64ARRAY

 

TibrvMsg.U64ARRAY

 

TibrvMsg.F32ARRAY

 

TibrvMsg.F64ARRAY

 

TibrvMsg.USER_FIRST

Custom datatypes begin with this number.

TibrvMsg.USER_LAST

 

See Also

Strings and Character Encodings

TibrvMsgField

Custom Datatypes