SnapshotSender::SetSnapshotPeriod

Defined in: C4Messages.h

Sets the snapshot period.

Prototype

void SetSnapshotPeriod(int32 period);

Parameters

period The new snapshot period. This should be greater than or equal to 1.

Description

The SetSnapshotPeriod function sets the period for a snapshot sender to that specified by the period parameter. The period is measured as an integer number of snapshot sending opportunities. In general, a period of n means that a snapshot is sent every n-th time the Message Manager schedules an opportunity to send snapshots. A period of 1 means that a snapshot is sent as often as possible, and this is the initial value upon construction of a SnapshotSender object.