API Reference

Welcome to the Exathread documentation. Here you can find comprehensive API information. Check out the API map below.

Class Hierarchy

• • Namespace exathread
    • Template Class Future
    • Template Class MultiFuture
    • Class Pool
    • Class Task
    • Template Class ValueTask
    • Class VoidTask
    • Enum Status

File Hierarchy

• • Directory include
    • File exathread.hpp

Full API

Namespaces

• Namespace exathread
  • Classes
  • Enums
  • Functions

Classes and Structs

• Template Class Future
  • Class Documentation
    • Future
      • Future::await()
      • Future::checkStatus()
      • Future::then()
      • Future::thenDetached()
      • Future::thenBatch()
      • Future::thenBatchDetached()
      • Future::operator*()
      • Future::operator*()
      • Future::operator->()
      • Future::operator->()

• Template Class MultiFuture
  • Class Documentation
    • MultiFuture
      • MultiFuture::MultiFuture()
      • MultiFuture::MultiFuture()
      • MultiFuture::size()
      • MultiFuture::await()
      • MultiFuture::checkStatus()
      • MultiFuture::then()
      • MultiFuture::thenDetached()
      • MultiFuture::thenBatch()
      • MultiFuture::thenBatchDetached()
      • MultiFuture::results()

• Class Pool
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • Pool
      • Pool::submit()
      • Pool::submitDetached()
      • Pool::batch()
      • Pool::batchDetached()
      • Pool::getThreadCount()
      • Pool::waitIdle()
      • Pool::~Pool()
      • Pool::Create()

• Class Task
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • Task
      • Task::Task()
      • Task::Task()
      • Task::Task()
      • Task::operator=()
      • Task::Task()
      • Task::operator=()
      • Task::~Task()
      • Task::done()
      • Task::resume()
      • Task::promise()
      • Task::promise()
      • Task::handle()

• Template Class ValueTask
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • ValueTask
      • ValueTask::promise_type
      • ValueTask::ValueTask()
      • ValueTask::ValueTask()

• Class VoidTask
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • VoidTask
      • VoidTask::promise_type
      • VoidTask::VoidTask()
      • VoidTask::VoidTask()

Enums

• Enum Status
  • Enum Documentation
    • Status
      • Status::Pending
      • Status::Scheduled
      • Status::Executing
      • Status::Yielded
      • Status::Failed
      • Status::Complete

Functions

• Template Function exathread::yieldFor
  • Function Documentation
    • yieldFor()

• Function exathread::yieldUntil
  • Function Documentation
    • yieldUntil()

• Template Function exathread::yieldUntilComplete(const Future<T>&)
  • Function Documentation
    • yieldUntilComplete()

• Template Function exathread::yieldUntilComplete(const MultiFuture<T>&)
  • Function Documentation
    • yieldUntilComplete()

• Function exathread::yieldUntilTrue
  • Function Documentation
    • yieldUntilTrue()