Message Operations by Functional Group

Function

Description

Message Life Cycle

tibrvMsg_Create()

Allocate storage and initialize it as a new message.

tibrvMsg_CreateCopy()

Copy a message.

tibrvMsg_Destroy()

Destroy a message; free the storage that it occupies.

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_Reset()

Clear a message, preparing it for re-use.

Message Attributes

tibrvMsg_GetNumFields()

Extract the number of fields in a message.

tibrvMsg_GetByteSize()

Return the size of a message (in bytes).

tibrvMsg_ConvertToString()

Format a message as a string.

Address Attributes

tibrvMsg_GetSendSubject()

Extract the subject from a message.

tibrvMsg_SetSendSubject()

Set the subject for a message.

tibrvMsg_GetReplySubject()

Extract the reply subject from a message.

tibrvMsg_SetReplySubject()

Set the reply subject for a message.

Message Fields

tibrvMsg_AddField()

Add a field to a message.

Add Scalar

Add Array

Add Nested Message

Add String

Add Opaque Byte Sequence

Add XML Byte Sequence

Add DateTime

tibrvMsg_GetField()

Get a specified field from a message.

Get Scalar

Get Array

Get Nested Message

Get String

Get Opaque Byte Sequence

Get XML Byte Sequence

Get DateTime

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.

Update Scalar

Update Array

Update Nested Message

Update String

Update Opaque Byte Sequence

Update XML Byte Sequence

Update DateTime

Archiving Messages as Byte Sequences

tibrvMsg_CreateFromBytes()

Create a new message, and populate it with data.

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.

Deleting Snapshot References

tibrvMsg_ClearReferences()

Clear references in this message.

tibrvMsg_MarkReferences()

Mark references in this message.

Dispatch Attributes

tibrvMsg_GetClosure()

Extract the closure object corresponding to a (dispatched) message object.

tibrvMsg_GetEvent()

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

Utilities

tibrvMsg_GetCurrentTime()

Get the current time.

Types

tibrvLocalData

This type is the union of all the datatypes that a Rendezvous message can contain as data in a message field.

tibrvMsg

This type represents inbound or outbound Rendezvous messages.

tibrvMsgDateTime

Represents dates and times.

tibrvMsgField

Fields hold data within messages. Programs manipulate the content of field structs using the public struct accessors of this type.

Custom Datatypes

tibrvMsg_SetHandlers()

Define a program-specific datatype, by registering functions to transfer it between local format and wire format, and convert it to other datatypes.