Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
roc::audio::WatchdogConfig Struct Reference

Watchdog parameters. More...

#include <watchdog.h>

Public Member Functions

 WatchdogConfig ()
 Initialize config with default values.
 

Public Attributes

core::nanoseconds_t no_playback_timeout
 Timeout for the lack of packets, nanoseconds.
 
core::nanoseconds_t broken_playback_timeout
 Timeout for frequent breakages, nanoseconds.
 
core::nanoseconds_t breakage_detection_window
 Breakage detection window, nanoseconds.
 
size_t frame_status_window
 Frame status window size for logging, number of frames.
 

Detailed Description

Watchdog parameters.

Definition at line 27 of file watchdog.h.

Constructor & Destructor Documentation

◆ WatchdogConfig()

roc::audio::WatchdogConfig::WatchdogConfig ( )
inline

Initialize config with default values.

Definition at line 55 of file watchdog.h.

Member Data Documentation

◆ breakage_detection_window

core::nanoseconds_t roc::audio::WatchdogConfig::breakage_detection_window

Breakage detection window, nanoseconds.

See also
broken_playback_timeout.

Definition at line 47 of file watchdog.h.

◆ broken_playback_timeout

core::nanoseconds_t roc::audio::WatchdogConfig::broken_playback_timeout

Timeout for frequent breakages, nanoseconds.

Remarks
Maximum allowed period during which every drop detection window overlaps with at least one frame which caused packet drops and with at least one frame which is incomplete (it may be the same frame). After this period, the session is terminated. This mechanism allows to detect the vicious circle when all client packets are a bit late and we are constantly dropping them producing unpleasant noise. Set to zero to disable.

Definition at line 43 of file watchdog.h.

◆ frame_status_window

size_t roc::audio::WatchdogConfig::frame_status_window

Frame status window size for logging, number of frames.

Remarks
Used for debug logging. Set to zero to disable.

Definition at line 52 of file watchdog.h.

◆ no_playback_timeout

core::nanoseconds_t roc::audio::WatchdogConfig::no_playback_timeout

Timeout for the lack of packets, nanoseconds.

Remarks
Maximum allowed period during which every frame is blank. After this period, the session is terminated. This mechanism allows to detect dead, hanging, or broken clients. Set to zero to disable.

Definition at line 33 of file watchdog.h.

The documentation for this struct was generated from the following file: