realtime_processor_mode.hpp File Reference

#include <functional>

Go to the source code of this file.

Enumerations
enum class	bnb::interfaces::realtime_processor_mode : int {   sync , sync_when_effect_loaded , async , async_when_effect_loaded ,   async_when_bootstrapped }

Enumeration Type Documentation

realtime_processor_mode

enum class bnb::interfaces::realtime_processor_mode : int

strong

Enumerator
sync	Synchronous mode. Frame drop not allowed, pop will block on processing.
sync_when_effect_loaded	Synchronous mode when effect loaded. Frame drop not allowed. During effect loading push will forward frames to pop, pop will return SKIP. When effect loaded, pop will block on processing.
async	Asynchronous mode. Frame drop is allowed. push and pop do not block on processing. push can drop frames, if processor busy, pop can return EMPTY, if no processed frame data for now.
async_when_effect_loaded	Asynchronous mode. Frame drop is allowed. push and pop do not block on processing. During effect loading push will forward frames to pop, pop will return SKIP. When effect loaded, push can drop frames, if processor busy, pop can return EMPTY, if no processed frame data for now.
async_when_bootstrapped	Asynchronous mode. Frame drop is allowed. push and pop do not block on processing. During processor bootstrap push will forward frames to pop, pop will return SKIP. When effect loaded, push can drop frames, if processor busy, pop can return EMPTY, if no processed frame data for now.

Definition at line 14 of file realtime_processor_mode.hpp.

                                   : int {
    /** Synchronous mode. Frame drop not allowed, `pop` will block on processing. */
    sync,
    /**
     * Synchronous mode when effect loaded. Frame drop not allowed.
     * During effect loading `push` will forward frames to `pop`, `pop` will return SKIP.
     * When effect loaded, `pop` will block on processing.
     */
    sync_when_effect_loaded,
    /**
     * Asynchronous mode. Frame drop is allowed. `push` and `pop` do not block on processing.
     * `push` can drop frames, if processor busy,
     * `pop` can return EMPTY, if no processed frame data for now.
     */
    async,
    /**
     * Asynchronous mode. Frame drop is allowed. `push` and `pop` do not block on processing.
     * During effect loading `push` will forward frames to `pop`, `pop` will return SKIP.
     * When effect loaded, `push` can drop frames, if processor busy,
     * `pop` can return EMPTY, if no processed frame data for now.
     */
    async_when_effect_loaded,
    /**
     * Asynchronous mode. Frame drop is allowed. `push` and `pop` do not block on processing.
     * During processor bootstrap `push` will forward frames to `pop`, `pop` will return SKIP.
     * When effect loaded, `push` can drop frames, if processor busy,
     * `pop` can return EMPTY, if no processed frame data for now.
     */
    async_when_bootstrapped,
};