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

A unique lease over immutable publication bytes. More...

#include <program_wire.hpp>

Public Member Functions

 ProgramWireBytePin ()=default
 ProgramWireBytePin (std::span< const std::byte > bytes, std::uintptr_t owner_token=0) noexcept
 ProgramWireBytePin (const ProgramWireBytePin &)=delete
ProgramWireBytePin & operator= (const ProgramWireBytePin &)=delete
 ProgramWireBytePin (ProgramWireBytePin &&other) noexcept
ProgramWireBytePin & operator= (ProgramWireBytePin &&other) noexcept
std::span< const std::byte > bytes () const noexcept
std::uintptr_t owner_token () const noexcept
 operator bool () const noexcept

Detailed Description

A unique lease over immutable publication bytes.

Moving the pin transfers the right to keep the bytes alive; rejected candidates and retired active publications are returned to the caller in ProgramWireAdoptionResult.

Constructor & Destructor Documentation

◆ ProgramWireBytePin() [1/4]

pulp::playback::ProgramWireBytePin::ProgramWireBytePin ( )
default

◆ ProgramWireBytePin() [2/4]

pulp::playback::ProgramWireBytePin::ProgramWireBytePin ( std::span< const std::byte > bytes,
std::uintptr_t owner_token = 0 )
inlineexplicitnoexcept

◆ ProgramWireBytePin() [3/4]

pulp::playback::ProgramWireBytePin::ProgramWireBytePin ( const ProgramWireBytePin & )
delete

◆ ProgramWireBytePin() [4/4]

pulp::playback::ProgramWireBytePin::ProgramWireBytePin ( ProgramWireBytePin && other)
inlinenoexcept

Member Function Documentation

◆ bytes()

std::span< const std::byte > pulp::playback::ProgramWireBytePin::bytes ( ) const
inlinenoexcept

◆ operator bool()

pulp::playback::ProgramWireBytePin::operator bool ( ) const
inlineexplicitnoexcept

◆ operator=() [1/2]

ProgramWireBytePin & pulp::playback::ProgramWireBytePin::operator= ( const ProgramWireBytePin & )
delete

◆ operator=() [2/2]

ProgramWireBytePin & pulp::playback::ProgramWireBytePin::operator= ( ProgramWireBytePin && other)
inlinenoexcept

◆ owner_token()

std::uintptr_t pulp::playback::ProgramWireBytePin::owner_token ( ) const
inlinenoexcept

The documentation for this class was generated from the following file:
  • /home/runner/work/pulp/pulp/core/playback/include/pulp/playback/program_wire.hpp