Audio Processing Framework (APF) version 0.5.0
Public Member Functions | List of all members
apf::CommandQueue::Command Struct Referenceabstract

Abstract base class for realtime commands. More...

#include <apf/commandqueue.h>

Inheritance diagram for apf::CommandQueue::Command:
Inheritance graph
[legend]

Public Member Functions

virtual ~Command ()
 Empty virtual destructor. More...
 
virtual void execute ()=0
 The actual implementation of the command. More...
 
virtual void cleanup ()=0
 Cleanup of resources. More...
 
- Public Member Functions inherited from apf::NonCopyable
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
 NonCopyable (NonCopyable &&)=default
 
NonCopyableoperator= (NonCopyable &&)=default
 

Additional Inherited Members

- Protected Member Functions inherited from apf::NonCopyable
 NonCopyable ()=default
 Protected default constructor. More...
 
 ~NonCopyable ()=default
 Protected non-virtual destructor. More...
 

Detailed Description

Abstract base class for realtime commands.

These commands are passed through queues into the realtime thread and after execution back to the non-realtime thread for cleanup.

Definition at line 54 of file commandqueue.h.

Constructor & Destructor Documentation

◆ ~Command()

virtual apf::CommandQueue::Command::~Command ( )
inlinevirtual

Empty virtual destructor.

Definition at line 57 of file commandqueue.h.

Member Function Documentation

◆ execute()

virtual void apf::CommandQueue::Command::execute ( )
pure virtual

The actual implementation of the command.

This is called from the realtime thread. Overwritten in the derived class.

Implemented in apf::RtList< T * >::AddCommand, apf::RtList< T * >::RemCommand, and apf::RtList< T * >::ClearCommand.

Referenced by apf::CommandQueue::process_commands(), and apf::CommandQueue::push().

◆ cleanup()

virtual void apf::CommandQueue::Command::cleanup ( )
pure virtual

Cleanup of resources.

This is called from the non-realtime thread. Overwritten in the derived class.

Implemented in apf::RtList< T * >::AddCommand, apf::RtList< T * >::RemCommand, and apf::RtList< T * >::ClearCommand.


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