tibrvMsgField

Type

Declaration

typedef struct
{
    char*               name;
    tibrv_u32           size;
    tibrv_u32           count;
    tibrvLocalData      data;
    tibrv_u16           id;
    tibrv_u8            type;
} tibrvMsgField;

Purpose

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

Accessor

Description

name

The field’s name. NULL signifies the empty string as the field name.

Field name strings use the ISO 8859-1 character encoding.

size

The size of the field’s data (in bytes).

For array types, size reflects the size (in bytes) of one array element. For TIBRVMSG_STRING, size reflects the number of bytes in the string (including the NULL terminator, if present). For TIBRVMSG_OPAQUE and TIBRVMSG_XML, size reflects the number of bytes of data.

count

The number of values in an array field. For array types, count is the number of array elements.

For example, when a field contains a array of ten 32-bit integers, its size is 4, and its count is 10.

(For scalar types, strings, opaque byte sequences and XML data, count is 1. That is, the field contains one string—not an array of characters; one opaque value—not an array of bytes.)

data

The field’s data value.

id

The field’s identifier. Identifiers are optional, but must be unique within each message.

type

A Rendezvous datatype token denoting the type of the field’s data.