StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Pipeline::Step::Join Class Referencefinal

Ensures a derived stage stops before its resources expire. More...

#include <StormByte/multimedia/pipeline/step.hxx>

Public Member Functions

 Join (Step &step) noexcept
 Guards the stage until execution finishes.
 Join (const Join &)=delete
 Copy construction is disabled.
 Join (Join &&) noexcept=delete
 Move construction is disabled.
 ~Join () noexcept
 Halts the stage and waits for execution to finish.
Join & operator= (const Join &)=delete
 Copy assignment is disabled.
Join & operator= (Join &&) noexcept=delete
 Move assignment is disabled.

Detailed Description

Ensures a derived stage stops before its resources expire.

Declare this guard last in a derived stage. Its destructor waits for stage execution to finish. Not a filter plugin API.

Constructor & Destructor Documentation

◆ Join() [1/3]

StormByte::Multimedia::Pipeline::Step::Join::Join ( Step & step)
inlineexplicitnoexcept

Guards the stage until execution finishes.

Parameters
stepStage to halt when this guard is destroyed.

◆ Join() [2/3]

StormByte::Multimedia::Pipeline::Step::Join::Join ( const Join & )
delete

Copy construction is disabled.

◆ Join() [3/3]

StormByte::Multimedia::Pipeline::Step::Join::Join ( Join && )
deletenoexcept

Move construction is disabled.

◆ ~Join()

StormByte::Multimedia::Pipeline::Step::Join::~Join ( )
inlinenoexcept

Halts the stage and waits for execution to finish.

Member Function Documentation

◆ operator=() [1/2]

Join & StormByte::Multimedia::Pipeline::Step::Join::operator= ( const Join & )
delete

Copy assignment is disabled.

Returns
This guard.

◆ operator=() [2/2]

Join & StormByte::Multimedia::Pipeline::Step::Join::operator= ( Join && )
deletenoexcept

Move assignment is disabled.

Returns
This guard.

The documentation for this class was generated from the following file:
  • lib/public/StormByte/multimedia/pipeline/step.hxx