SnapshotSender::SendSnapshot

Defined in: C4Messages.h

Called when the Message Manager sends a snapshot.

Prototype

virtual void SendSnapshot(void) = 0;

Description

The SendSnapshot function is called by the Message Manager on the server machine at regular intervals for each snapshot sender. The frequency at which the SendSnapshot function is called depends on the sender-specific snapshot period set by the SnapshotSender::SetSnapshotPeriod function and the global snapshot interval set by the MessageMgr::SetSnapshotInterval function.

The implementation of the SendSnapshot function should typically send messages to client machines using the MessageMgr::SendMessageClients function, but it may send messages only to particular client machines instead if it's not necessary to send information to all clients. The SendSnapshot function should not send messages that would be received by the server machine; in particular, it should not call the MessageMgr::SendMessageAll function. Nor should the SendSnapshot function send any messages that are journaled.