Classe task_group

La classe task_group rappresenta una raccolta di lavoro parallelo che può essere messa in attesa o annullata.

Sintassi

class task_group;

Membri

Costruttori pubblici

Metodi pubblici

Osservazioni:

A differenza della classe fortemente limitata structured_task_group , la task_group classe è molto più generale costrutto. Non sono previste restrizioni descritte da structured_task_group. task_group gli oggetti possono essere usati in modo sicuro tra thread e utilizzati in modi in formato libero. Lo svantaggio del task_group costrutto è che potrebbe non essere eseguito e il structured_task_group costrutto per le attività che eseguono piccole quantità di lavoro.

Per altre informazioni, vedere Parallelismo delle attività.

Gerarchia di ereditarietà

task_group

Requisiti

Intestazione: ppl.h

Spazio dei nomi: Concurrency

cancel

Tenta di annullare l'albero secondario del lavoro radicato in questo gruppo di attività. Se possibile, ogni attività pianificata nel gruppo di attività verrà annullata in modo transitivo.

void cancel();

Osservazioni:

Per altre informazioni, vedere Annullamento.

is_canceling

Informa il chiamante se il gruppo di attività è attualmente incluso in un annullamento. Ciò non indica necessariamente che il cancel metodo è stato chiamato sull'oggetto task_group (anche se tale certamente qualifica questo metodo per restituire true). È possibile che l'oggetto task_group sia in esecuzione inline e che un gruppo di attività più avanti nell'albero di lavoro sia stato annullato. Nei casi come questi in cui il runtime può determinare in anticipo che l'annullamento scorrerà attraverso questo task_group oggetto, true verrà restituito anche .

bool is_canceling();

Valore restituito

Indicazione del fatto che l'oggetto task_group si trova in mezzo a un annullamento (o che sia garantito di essere a breve).

Osservazioni:

Per altre informazioni, vedere Annullamento.

run

Pianifica un'attività sull'oggetto task_group . Se un task_handle oggetto viene passato come parametro a run, il chiamante è responsabile della gestione della durata dell'oggetto task_handle . La versione del metodo che accetta un riferimento a un oggetto funzione come parametro comporta l'allocazione dell'heap all'interno del runtime che può essere eseguita meno bene rispetto all'uso della versione che accetta un riferimento a un task_handle oggetto . La versione che accetta il parametro _Placement comporta che per l'attività venga data priorità all'esecuzione nella posizione specificata da quel parametro.

template<
   typename _Function
>
void run(
   const _Function& _Func
);

template<
   typename _Function
>
void run(
   const _Function& _Func,
   location& _Placement
);

template<
   typename _Function
>
void run(
   task_handle<_Function>& _Task_handle
);

template<
   typename _Function
>
void run(
   task_handle<_Function>& _Task_handle,
   location& _Placement
);

Parametri

_Funzione
Tipo dell'oggetto funzione che verrà richiamato per eseguire il corpo dell'handle di attività.

_Func
Funzione che verrà chiamata per richiamare il corpo dell'attività. Può trattarsi di un'espressione lambda o di un altro oggetto che supporta una versione dell'operatore di chiamata di funzione con la firma void operator()().

_Collocamento
Riferimento alla posizione in cui deve essere eseguita l'attività rappresentata dal parametro _Func.

_Task_handle
Handle per il lavoro pianificato. Si noti che il chiamante ha la responsabilità per la durata di questo oggetto. Il runtime continuerà a aspettarsi che sia attivo fino a quando non viene chiamato il wait metodo o run_and_wait su questo task_group oggetto.

Osservazioni:

Il runtime pianifica la funzione di lavoro fornita da eseguire in un secondo momento, che può essere dopo la restituzione della funzione chiamante. Questo metodo usa un oggetto task_handle per contenere una copia della funzione di lavoro fornita. Pertanto, eventuali modifiche di stato che si verificano in un oggetto funzione passato a questo metodo non verranno visualizzate nella copia di tale oggetto funzione. Assicurarsi inoltre che la durata di tutti gli oggetti passati per puntatore o riferimento alla funzione di lavoro rimanga valida fino a quando la funzione di lavoro non viene restituita.

Se i task_group distruttori come risultato della rimozione dello stack da un'eccezione, non è necessario garantire che sia stata effettuata una chiamata al wait metodo o run_and_wait . In questo caso, il distruttore annulla e attende il completamento dell'attività rappresentata dal _Task_handle parametro .

Il metodo genera un'eccezione invalid_multiple_scheduling se l'handle di attività specificato dal _Task_handle parametro è già stato pianificato in un oggetto gruppo di attività tramite il run metodo e non è stata eseguita alcuna chiamata al wait metodo o run_and_wait su tale gruppo di attività.

run_and_wait

Pianifica l'esecuzione di un'attività inline nel contesto chiamante con l'assistenza dell'oggetto per il supporto completo dell'annullamento task_group . La funzione attende quindi che tutto il lavoro sull'oggetto task_group sia stato completato o annullato. Se un task_handle oggetto viene passato come parametro a run_and_wait, il chiamante è responsabile della gestione della durata dell'oggetto task_handle .

template<
   class _Function
>
task_group_status run_and_wait(
   task_handle<_Function>& _Task_handle
);

template<
   class _Function
>
task_group_status run_and_wait(
   const _Function& _Func
);

Parametri

_Funzione
Tipo dell'oggetto funzione che sarà richiamato per eseguire il corpo dell'attività.

_Task_handle
Handle per l'attività che verrà eseguita inline nel contesto chiamante. Si noti che il chiamante ha la responsabilità per la durata di questo oggetto. Il runtime continuerà ad aspettarsi che sia attivo fino al termine dell'esecuzione del run_and_wait metodo.

_Func
Funzione che verrà chiamata per richiamare il corpo del lavoro. Può trattarsi di un'espressione lambda o di un altro oggetto che supporta una versione dell'operatore di chiamata di funzione con la firma void operator()().

Valore restituito

Indica se l'attesa è stata soddisfatta o se il gruppo di attività è stato annullato, a causa di un'operazione di annullamento esplicita o di un'eccezione generata da una delle attività. Per altre informazioni, vedere task_group_status.

Osservazioni:

Si noti che una o più delle attività pianificate per questo task_group oggetto possono essere eseguite inline nel contesto chiamante.

Se una o più delle attività pianificate per questo task_group oggetto generano un'eccezione, il runtime selezionerà un'eccezione di questo tipo dalla scelta e la propaga all'esterno della chiamata al run_and_wait metodo .

Quando viene restituito dal run_and_wait metodo su un task_group oggetto, il runtime reimposta l'oggetto in uno stato pulito in cui può essere riutilizzato. Ciò include il caso in cui l'oggetto task_group è stato annullato.

Nel percorso di esecuzione non eccezionale è necessario chiamare questo metodo o il wait metodo prima del distruttore dell'esecuzione task_group .

task_group

Costruisce un oggetto task_group nuovo.

task_group();

task_group(
   cancellation_token _CancellationToken
);

Parametri

_CancellationToken
Token di annullamento da associare a questo gruppo di attività. Il gruppo di attività verrà annullato quando il token viene annullato.

Osservazioni:

Tramite il costruttore che accetta un token di annullamento viene creato un oggetto task_group che verrà annullato quando l'origine associata al token viene annullata. Fornire un token di annullamento esplicito permette di isolare questo gruppo di attività dalla partecipazione a un annullamento implicito di un gruppo padre con un token diverso o senza token.

~task_group

Elimina un oggetto task_group . È previsto chiamare il wait metodo o run_and_wait sull'oggetto prima dell'esecuzione del distruttore, a meno che il distruttore non venga eseguito come risultato della rimozione dello stack a causa di un'eccezione.

~task_group();

Osservazioni:

Se il distruttore viene eseguito come risultato della normale esecuzione (ad esempio, non rimozione dello stack a causa di un'eccezione) e nessuno dei wait metodi né run_and_wait è stato chiamato, il distruttore può generare un'eccezione missing_wait .

wait

Attende che tutto il lavoro sull'oggetto task_group sia stato completato o annullato.

task_group_status wait();

Valore restituito

Indica se l'attesa è stata soddisfatta o se il gruppo di attività è stato annullato, a causa di un'operazione di annullamento esplicita o di un'eccezione generata da una delle attività. Per altre informazioni, vedere task_group_status.

Osservazioni:

Si noti che una o più delle attività pianificate per questo task_group oggetto possono essere eseguite inline nel contesto chiamante.

Se una o più delle attività pianificate per questo task_group oggetto generano un'eccezione, il runtime selezionerà un'eccezione di questo tipo dalla scelta e la propaga all'esterno della chiamata al wait metodo .

La chiamata wait a un task_group oggetto lo reimposta in uno stato pulito in cui può essere riutilizzato. Ciò include il caso in cui l'oggetto task_group è stato annullato.

Nel percorso di esecuzione non eccezionale è necessario chiamare questo metodo o il run_and_wait metodo prima del distruttore dell'esecuzione task_group .

Vedi anche

Spazio dei nomi concurrency
Classe structured_task_group
Classe task_handle