Created by AudioWorkgroup to join the calling thread to a workgroup. More...

#include "juce_AudioWorkgroup.h"

Classes
class	TokenProvider

Public Types
using	Erased = FixedSizeFunction< 64, const TokenProvider *()>

Public Member Functions
	WorkgroupToken (Erased e)

	~WorkgroupToken ()=default
	If the token joined the calling thread to a workgroup during construction, the destructor will cause the calling thread to leave that workgroup.

	WorkgroupToken (const WorkgroupToken &)=delete

	WorkgroupToken (WorkgroupToken &&) noexcept=default

WorkgroupToken &	operator= (const WorkgroupToken &)=delete

WorkgroupToken &	operator= (WorkgroupToken &&)=default

	operator bool () const
	Returns true if and only if getTokenProvider() returns non-null.

const TokenProvider *	getTokenProvider () const
	The result of this function can be compared to nullptr to check whether the token successfully joined the calling thread to a workgroup.

void	reset ()
	If this token was engaged by joining a workgroup, leaves that workgroup and disengages the token.

Detailed Description

Created by AudioWorkgroup to join the calling thread to a workgroup.

To leave the workgroup again, destroy the WorkgroupToken.

See also: AudioWorkgroup

@tags{Audio}

Definition at line 35 of file juce_AudioWorkgroup.h.

Class Documentation

◆ juce::WorkgroupToken::TokenProvider

class juce::WorkgroupToken::TokenProvider

Definition at line 164 of file juce_AudioWorkgroup.cpp.

Member Typedef Documentation

◆ Erased

using juce::WorkgroupToken::Erased = FixedSizeFunction<64, const TokenProvider*()>

Definition at line 42 of file juce_AudioWorkgroup.h.

Constructor & Destructor Documentation

◆ WorkgroupToken()

juce::WorkgroupToken::WorkgroupToken ( Erased e )

explicit

Definition at line 48 of file juce_AudioWorkgroup.h.

Member Function Documentation

◆ getTokenProvider()

const TokenProvider * juce::WorkgroupToken::getTokenProvider ( ) const

The result of this function can be compared to nullptr to check whether the token successfully joined the calling thread to a workgroup.

Used in the implementation to provide platform-specific information about this token.

Definition at line 80 of file juce_AudioWorkgroup.h.

◆ operator bool()

juce::WorkgroupToken::operator bool ( ) const

explicit

Returns true if and only if getTokenProvider() returns non-null.

Definition at line 73 of file juce_AudioWorkgroup.h.

◆ reset()

void juce::WorkgroupToken::reset ( )

If this token was engaged by joining a workgroup, leaves that workgroup and disengages the token.

After this call, getTokenProvider() will return nullptr.

Definition at line 86 of file juce_AudioWorkgroup.h.

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

juce_audio_basics/utilities/juce_AudioWorkgroup.h

Classes

Public Types

Public Member Functions