Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::inspect::MotionInspector Class Reference

#include <motion_inspector.hpp>

Public Member Functions

 MotionInspector (pulp::view::View &root, InspectorEventSink event_sink={})
 Construct with a root view for node-id lookup and an optional event delivery callback.
 ~MotionInspector ()
 MotionInspector (const MotionInspector &)=delete
MotionInspector & operator= (const MotionInspector &)=delete
InspectorMessage handle (const InspectorMessage &req)
 Handle a Motion.* request. Returns response message.
std::size_t active_trace_count () const
 Number of currently-attached inspector traces.
MotionTraceAttachResult attach_trace (const MotionTraceSpec &spec, std::string owner, std::function< bool()> authority_live, std::function< std::shared_ptr< void >(std::function< void()>)> subscribe_authority_end)
 Transport-independent host operations used by canonical capability executors.
bool detach_trace (std::int64_t trace_id, std::string_view owner)
bool begin_cost_observation (std::string owner, std::function< bool()> authority_live)
bool end_cost_observation (std::string_view owner)
std::vector< pulp::view::motion::CostSample > recent_cost_samples (std::size_t maximum_samples, std::string_view owner) const

Constructor & Destructor Documentation

◆ MotionInspector() [1/2]

pulp::inspect::MotionInspector::MotionInspector ( pulp::view::View & root,
InspectorEventSink event_sink = {} )
explicit

Construct with a root view for node-id lookup and an optional event delivery callback.

Without a callback, traces still register and tick; events fan out to sinks installed directly on the coordinator.

◆ ~MotionInspector()

pulp::inspect::MotionInspector::~MotionInspector ( )

◆ MotionInspector() [2/2]

pulp::inspect::MotionInspector::MotionInspector ( const MotionInspector & )
delete

Member Function Documentation

◆ active_trace_count()

std::size_t pulp::inspect::MotionInspector::active_trace_count ( ) const

Number of currently-attached inspector traces.

◆ attach_trace()

MotionTraceAttachResult pulp::inspect::MotionInspector::attach_trace ( const MotionTraceSpec & spec,
std::string owner,
std::function< bool()> authority_live,
std::function< std::shared_ptr< void >(std::function< void()>)> subscribe_authority_end )

Transport-independent host operations used by canonical capability executors.

They never emit or decode legacy protocol method names.

◆ begin_cost_observation()

bool pulp::inspect::MotionInspector::begin_cost_observation ( std::string owner,
std::function< bool()> authority_live )

◆ detach_trace()

bool pulp::inspect::MotionInspector::detach_trace ( std::int64_t trace_id,
std::string_view owner )

◆ end_cost_observation()

bool pulp::inspect::MotionInspector::end_cost_observation ( std::string_view owner)

◆ handle()

InspectorMessage pulp::inspect::MotionInspector::handle ( const InspectorMessage & req)

Handle a Motion.* request. Returns response message.

◆ operator=()

MotionInspector & pulp::inspect::MotionInspector::operator= ( const MotionInspector & )
delete

◆ recent_cost_samples()

std::vector< pulp::view::motion::CostSample > pulp::inspect::MotionInspector::recent_cost_samples ( std::size_t maximum_samples,
std::string_view owner ) const

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