Built-In Formats Reference

Built-in formats are optimized for efficiency, and are always available. Administrators do not need to explicitly define them, nor specify them among an application’s preload formats.

The C API defines global constants as listed in the following table.

The Java API defines these constants as fields of class Message.

The .NET API defines these constants as fields of class FTL.

Built-In Formats
Format Name Constant Description
TIB_BUILTIN_MSG_FMT_OPAQUE The message consists of a singleton field of type opaque.

The constant TIB_BUILTIN_MSG_FMT_OPAQUE_FIELDNAME denotes the name of that singleton field. (The value of the constant is _data.)

For the fastest and most efficient message transfer, limit the data payload to TIB_BUILTIN_MSG_FMT_OPAQUE_MAXSIZE (12000 bytes).

TIB_BUILTIN_MSG_FMT_KEYED_OPAQUE This keyed opaque format enhances the opaque format with a key field of type string. Content matchers can match against the key field.

The constant TIB_BUILTIN_MSG_FMT_KEY_FIELDNAME denotes the name of the string field. (The value of the constant is _key.)

The constant value TIB_BUILTIN_MSG_FMT_KEY_MAXLEN is the maximum length, in bytes, of the key string field, including the null terminator character.

The constant TIB_BUILTIN_MSG_FMT_OPAQUE_FIELDNAME denotes the name of the opaque data field. (The value of the constant is _data.)

For the fastest and most efficient message transfer, limit the data payload to TIB_BUILTIN_MSG_FMT_OPAQUE_MAXSIZE (12000 bytes). Payload size includes the key, with its null terminator character, and the opaque data.