LogPlayerSettings Class Reference

#include <OnixS/CME/MDH/Replay.h>

Public Member Functions
	LogPlayerSettings (ChannelId channel, FileList logs) noexcept
const FileList &	logs () const noexcept
LogPlayerSettings &	logs (FileList logs) noexcept
ChannelId	channel () const noexcept
LogPlayerSettings &	channel (ChannelId value) noexcept
Messaging::TimeSpan	sendDelay () const noexcept
LogPlayerSettings &	sendDelay (Messaging::TimeSpan value) noexcept
bool	useNaturalSendDelays () const noexcept
LogPlayerSettings &	useNaturalSendDelays (bool value) noexcept
bool	updateSendingTime () const noexcept
LogPlayerSettings &	updateSendingTime (bool value) noexcept
Messaging::TimeSpan	sourceSwitchDelay () const noexcept
LogPlayerSettings &	sourceSwitchDelay (Messaging::TimeSpan value) noexcept
LogPlayerSettings &	delayPolicy (ReplayDelayer &delayer) noexcept
ReplayDelayer &	delayPolicy () const noexcept
size_t	incrementalPacketsCount () const noexcept
LogPlayerSettings &	incrementalPacketsCount (size_t value) noexcept

Detailed Description

Definition at line 585 of file Replay.h.

Constructor & Destructor Documentation

LogPlayerSettings()

LogPlayerSettings ( ChannelId channel, FileList logs )

inlinenoexcept

Initializes settings for the specified channel and log files.

Parameters

channel	Channel identifier used to extract feed settings from the logs.
logs	Ordered list of Handler log files to replay.

Definition at line 592 of file Replay.h.

Member Function Documentation

channel() [1/2]

ChannelId channel ( ) const

inlinenoexcept

Returns the channel identifier used to extract feed settings from the logs.

Definition at line 613 of file Replay.h.

channel() [2/2]

LogPlayerSettings & channel ( ChannelId value )

inlinenoexcept

Sets the channel identifier used to extract feed settings from the logs.

Returns

Reference to this settings object.

Definition at line 621 of file Replay.h.

delayPolicy() [1/2]

ReplayDelayer & delayPolicy ( ) const

inlinenoexcept

Indicates policy for implementing replay delay.

Definition at line 721 of file Replay.h.

delayPolicy() [2/2]

LogPlayerSettings & delayPolicy ( ReplayDelayer & delayer )

inlinenoexcept

Sets a policy for implementing replay delay.

Returns

Reference to this settings object.

Definition at line 714 of file Replay.h.

incrementalPacketsCount() [1/2]

size_t incrementalPacketsCount ( ) const

inlinenoexcept

Returns the maximum number of packets to replay to incremental feed targets.

Packets logged for historical feeds are published to incremental feed targets and are included in this limit.

Note

Default value is std::numeric_limits<size_t>::max(), which does not impose a practical replay limit.

Definition at line 734 of file Replay.h.

incrementalPacketsCount() [2/2]

LogPlayerSettings & incrementalPacketsCount ( size_t value )

inlinenoexcept

Sets the maximum number of packets to replay to incremental feed targets.

Replay stops after this many packets have been sent to incremental feed targets, or after all log data has been processed. Packets logged for historical feeds are published to incremental feed targets and are included in this limit.

Returns

Reference to this settings object.

Definition at line 747 of file Replay.h.

logs() [1/2]

const FileList & logs ( ) const

inlinenoexcept

Returns the ordered list of Handler log files to replay.

Definition at line 598 of file Replay.h.

logs() [2/2]

LogPlayerSettings & logs ( FileList logs )

inlinenoexcept

Replaces the ordered list of Handler log files to replay.

Returns

Reference to this settings object.

Definition at line 606 of file Replay.h.

sendDelay() [1/2]

Messaging::TimeSpan sendDelay ( ) const

inlinenoexcept

Returns the fixed delay applied before each replayed packet.

The value is used when useNaturalSendDelays() is false. It is applied independently of sourceSwitchDelay(), so a packet that changes source is delayed by both values.

Note

Default value is 100 microseconds.

Definition at line 634 of file Replay.h.

sendDelay() [2/2]

LogPlayerSettings & sendDelay ( Messaging::TimeSpan value )

inlinenoexcept

Sets the fixed delay applied before each replayed packet.

The value is used when useNaturalSendDelays() is false. It is applied independently of sourceSwitchDelay(), so a packet that changes source is delayed by both values.

Returns

Reference to this settings object.

Definition at line 646 of file Replay.h.

sourceSwitchDelay() [1/2]

Messaging::TimeSpan sourceSwitchDelay ( ) const

inlinenoexcept

Returns the delay applied when target NetFeedType changes.

This delay is applied in addition to sendDelay() when natural send delays are disabled.

Note

Default value is 1 millisecond.

Definition at line 695 of file Replay.h.

sourceSwitchDelay() [2/2]

LogPlayerSettings & sourceSwitchDelay ( Messaging::TimeSpan value )

inlinenoexcept

Sets the delay applied when target NetFeedType changes.

This delay is applied in addition to sendDelay() when natural send delays are disabled.

Returns

Reference to this settings object.

Definition at line 705 of file Replay.h.

updateSendingTime() [1/2]

bool updateSendingTime ( ) const

inlinenoexcept

Indicates whether SendingTime is updated before each packet is sent.

Note

Default value is false, so logged SendingTime values are preserved.

Definition at line 676 of file Replay.h.

updateSendingTime() [2/2]

LogPlayerSettings & updateSendingTime ( bool value )

inlinenoexcept

Enables or disables updating SendingTime before each packet is sent.

Returns

Reference to this settings object.

Definition at line 684 of file Replay.h.

useNaturalSendDelays() [1/2]

bool useNaturalSendDelays ( ) const

inlinenoexcept

Indicates whether packet send delays are taken from the log timestamps.

When enabled, packets preserve the original timing recorded in the logs. When disabled, sendDelay() is used for each replayed packet.

Note

Default value is false.

Definition at line 658 of file Replay.h.

useNaturalSendDelays() [2/2]

LogPlayerSettings & useNaturalSendDelays ( bool value )

inlinenoexcept

Enables or disables delays based on the original log timestamps.

Returns

Reference to this settings object.

See also

sendDelay

Definition at line 667 of file Replay.h.