tibemsMsg_GetByteSize

Purpose

Compute the size of the byte sequence representation of the message.

C Declaration

tibems_status tibemsMsg_GetByteSize(
    tibemsMsg message,
    tibems_int* size );

COBOL Call

CALL "tibemsMsg_GetByteSize"
     USING BY VALUE message,
           BY REFERENCE size,
           RETURNING tibems-status
END-CALL.

Parameters

Remarks

This call computes the size of a message in bytes. This measurement accounts for the actual space that the wire format message occupies, including its header, properties, and body data. (It does not include allocated storage that remains unused.)

Before calling tibemsMsg_GetAsBytesCopy, use this call to measure the size of a message, then allocate sufficient space to store a copy.

You can also use this call to measure network throughput, or to limit a program’s output rate (also called throttling).

Deprecated Form

tibems_int tibemsMsg_ByteSize(
    tibemsMsg message );

See Also

tibemsMsg_GetAsBytesCopy