MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Vruta::event_promise Struct Reference

#include <Promise.hpp>

+ Inheritance diagram for MayaFlux::Vruta::event_promise:
+ Collaboration diagram for MayaFlux::Vruta::event_promise:

Public Member Functions

Event get_return_object ()
 
void own (std::shared_ptr< Vruta::NetworkSource > source)
 Transfer ownership of a NetworkSource to this coroutine frame.
 
- Public Member Functions inherited from MayaFlux::Vruta::routine_promise< Event >
void domain_mismatch_error (const std::string &awaiter_name, const std::string &suggestion)
 
CompletionAwaiter final_suspend () noexcept
 Determines whether the coroutine suspends before destruction.
 
Event get_return_object ()
 
T * get_state (const std::string &key)
 Retrieves a value from the state dictionary.
 
std::suspend_never initial_suspend ()
 Determines whether the coroutine suspends immediately upon creation.
 
void notify_complete () noexcept
 
void on_complete (std::function< void()> callback)
 
void return_void ()
 Handles the coroutine's void return.
 
void set_should_terminate (bool value) noexcept
 
void set_state (const std::string &key, T value)
 Stores a value in the state dictionary.
 
void unhandled_exception ()
 Handles exceptions thrown from within the coroutine.
 

Public Attributes

DelayContext active_delay_context { DelayContext::EVENT_BASED }
 
std::vector< std::shared_ptr< Vruta::NetworkSource > > owned_sources
 Coroutine-owned NetworkSource instances.
 
ProcessingToken processing_token { ProcessingToken::EVENT_DRIVEN }
 
- Public Attributes inherited from MayaFlux::Vruta::routine_promise< Event >
bool auto_resume
 Flag indicating whether the coroutine should be automatically resumed.
 
std::function< void()> completion_callback
 
std::atomic< bool > completion_notified
 
std::atomic< bool > completion_registered
 
std::atomic< bool > completion_signaled
 
uint64_t delay_amount
 Amount of delay requested by the coroutine.
 
const ProcessingToken processing_token
 Token indicating how this coroutine should be processed.
 
std::atomic< bool > should_terminate
 Flag indicating whether the coroutine should be terminated.
 
std::unordered_map< std::string, std::any > state
 Dictionary for storing arbitrary state data.
 
const bool sync_to_clock
 Flag indicating whether the coroutine should synchronize with the audio clock.
 

Detailed Description

Definition at line 516 of file Promise.hpp.


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