Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::audio::Watchdog Class Reference

Watchdog. More...

#include <watchdog.h>

Inheritance diagram for roc::audio::Watchdog:
Collaboration diagram for roc::audio::Watchdog:

Public Member Functions

 Watchdog (IReader &reader, size_t num_channels, const WatchdogConfig &config, size_t sample_rate, core::IAllocator &allocator)
 Initialize. More...
 
bool valid () const
 Check if object is successfully constructed. More...
 
virtual void read (Frame &frame)
 Read audio frame. More...
 
bool update ()
 Update stream. More...
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data. More...
 

Detailed Description

Watchdog.

Remarks
Terminates session if it is considered dead or corrupted.

Definition at line 65 of file watchdog.h.

Constructor & Destructor Documentation

roc::audio::Watchdog::Watchdog ( IReader reader,
size_t  num_channels,
const WatchdogConfig config,
size_t  sample_rate,
core::IAllocator allocator 
)

Initialize.

Member Function Documentation

virtual void roc::audio::Watchdog::read ( Frame frame)
virtual

Read audio frame.

Remarks
Updates stream state and reads frame from the input reader.

Implements roc::audio::IReader.

bool roc::audio::Watchdog::update ( )

Update stream.

Returns
false if during the session timeout each frame has an empty flag or the maximum allowed number of consecutive windows that can contain frames that aren't fully filled and contain dropped packets was exceeded.
bool roc::audio::Watchdog::valid ( ) const

Check if object is successfully constructed.


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