Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::format::StandaloneControlHost Class Referenceabstract

Optional host-side control composition for one ordinary StandaloneApp. More...

#include <standalone_control_host.hpp>

Public Member Functions

virtual ~StandaloneControlHost ()=default
virtual bool start (Processor &processor, state::StateStore &store, detail::StandaloneTestInputHost *test_input=nullptr, double sample_rate=0.0, StandaloneControlUiMode ui_mode=StandaloneControlUiMode::Headless)=0
 Called after the processor has registered its complete parameter catalog and the Standalone app has otherwise started successfully.
virtual bool attach_editor (ViewBridge &, view::View &, view::WindowHost &)
 Complete a deferred UI-capable startup against the editor that the Standalone is actually presenting.
virtual void stop () noexcept=0
 Revoke host-side authority before the processor or StateStore retires.
virtual bool ready () const noexcept
 Whether the host can still serve the broker connection.
virtual void poll () noexcept
 Run bounded host-main work admitted by the broker.

Detailed Description

Optional host-side control composition for one ordinary StandaloneApp.

The base standalone archive owns only this lifecycle boundary and remains independent of every control protocol and transport type. An explicitly control-enabled executable installs one factory from its generated target source; production-stripped executables install nothing.

Constructor & Destructor Documentation

◆ ~StandaloneControlHost()

virtual pulp::format::StandaloneControlHost::~StandaloneControlHost ( )
virtualdefault

Member Function Documentation

◆ attach_editor()

virtual bool pulp::format::StandaloneControlHost::attach_editor ( ViewBridge & ,
view::View & ,
view::WindowHost &  )
inlinevirtual

Complete a deferred UI-capable startup against the editor that the Standalone is actually presenting.

The control host borrows all three objects until stop(); it must never create a second processor view.

◆ poll()

virtual void pulp::format::StandaloneControlHost::poll ( )
inlinevirtualnoexcept

Run bounded host-main work admitted by the broker.

The Standalone event loop and the dedicated companion both call this on their owning main thread; an inert direct launch has no queued work.

◆ ready()

virtual bool pulp::format::StandaloneControlHost::ready ( ) const
inlinevirtualnoexcept

Whether the host can still serve the broker connection.

Inert direct launches remain ready; a broker-launched companion becomes unready as soon as its authenticated carrier closes.

◆ start()

virtual bool pulp::format::StandaloneControlHost::start ( Processor & processor,
state::StateStore & store,
detail::StandaloneTestInputHost * test_input = nullptr,
double sample_rate = 0.0,
StandaloneControlUiMode ui_mode = StandaloneControlUiMode::Headless )
pure virtual

Called after the processor has registered its complete parameter catalog and the Standalone app has otherwise started successfully.

A direct user launch with no broker bootstrap remains an inert launch.

◆ stop()

virtual void pulp::format::StandaloneControlHost::stop ( )
pure virtualnoexcept

Revoke host-side authority before the processor or StateStore retires.


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