TibrvMsg

Class

Declaration

class TibrvMsg

Purpose

Represent Rendezvous messages.

Remarks

This class lacks create() and destroy() methods; use the constructor and destructor instead.

Method

Description

Message Life Cycle and Properties

TibrvMsg()

Create a message object.

~TibrvMsg()

Destroy a message object.

TibrvMsg::convertToString()

Format a message as a string.

TibrvMsg::createCopy()

Store a copy of this message in another message object.

TibrvMsg::detach()

Detach an inbound message from Rendezvous storage; the program assumes responsibility for destroying the message.

TibrvMsg::expand()

Enlarge a message by allocating additional storage.

TibrvMsg::getAsBytes()

Extract the data from a message as a byte sequence.

TibrvMsg::getAsBytesCopy()

Extract a copy of the data from a message as a byte sequence.

TibrvMsg::getByteSize()

Return the size of a message (in bytes).

TibrvMsg::getHandle()

Extract the C message handle from a C++ message object.

TibrvMsg::getNumFields()

Extract the number of fields in a message.

TibrvMsg::getStatus()

Extract the status code stored by the message constructor.

TibrvMsg::isDetached()

Determine the ownership of the message.

TibrvMsg::reset()

Clear a message, preparing it for re-use.

Fields

TibrvMsg::addField()

Add a field object to a message.

TibrvMsg::getField()

Get a specified field from a message.

TibrvMsg::getFieldByIndex()

Get a field from a message by an index.

TibrvMsg::getFieldInstance()

Get a specified 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::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.

Field References

TibrvMsg::clearReferences()

Clear references in this message.

TibrvMsg::markReferences()

Mark references in this message.

Event Dispatched

TibrvMsg::getEvent()

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

Time String

TibrvMsg::getCurrentTime()

Get the current date and time.

See Also

Strings and Character Encodings

TibrvMsgField

Datatypes