SnapshotSender::GetSnapshotPeriod

Defined in: C4Messages.h

Returns the snapshot period.

Prototype

int32 GetSnapshotPeriod(void) const;

Description

The GetSnapshotPeriod function returns the period for a snapshot sender. 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.