tibrvMsg_GetByteSize()

Function

Declaration

tibrv_status tibrvMsg_GetByteSize(
    tibrvMsg          message,
    tibrv_u32*        byteSize);

Purpose

Return the size of a message (in bytes).

Remarks

This measurement accounts for the actual space that the message occupies (in wire format), including its header and its fields. It does not include storage that is allocated but unused. It does not include address information, such as the subject or reply subject.

Programs can use this function as part of these tasks:

•

Measure the size of message before allocating space to store a copy—as with tibrvMsg_GetAsBytesCopy().

•

Assess throughput rates.

•

Limit output rates (also called throttling).

Parameter	Description
message	Return the size of this message.
byteSize	The program supplies a location. The function stores the message size (in bytes) in that location.

See Also

tibrvMsg_GetAsBytes()

tibrvMsg_GetAsBytesCopy()