nn::nex::Station::FlushBundle Member Function

Syntax

qResult FlushBundle(
     qBool bFlushTransportBundles = true
);

Parameters

Name Description
in bFlushTransportBundles When this is true, the transport message bundle is also flushed after the message bundle. (The default is true.)

Return Values

Returns the function's result.

Description

Sends all messages currently stored in this station as a message bundle.

A message bundle is a feature that temporarily pools and holds outgoing messages. It sends them only after a sufficient number is collected. This can save bandwidth. See the NEX programming manual for details.

The transmission message bundle must be flushed periodically, so when calling this function at a normal interval, bFlushTransportBundles must be set to true.

See Also

FlushAllBundles, BundlingPolicy

Revision History

2011/01/27
Initial version.

CONFIDENTIAL