Open Search
    Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
    Promise< T > Class Template Reference
    Threading

    #include <job.h>

    Inheritance diagram for Promise< T >:
    Inheritance graph
    [legend]

    Detailed Description

    template<typename T>
    class maxon::Promise< T >

    A rudimentary promise.

    Public Member Functions

    Result< void > operator() ()
     
    - Public Member Functions inherited from JobResultInterface< RESULTVALUETYPE >
    Result< RESULTVALUETYPE > GetResult (TimeValue timeout=TIMEVALUE_INFINITE, WAITMODE mode=WAITMODE::DEFAULT) const
     
    Result< RESULTVALUETYPE > MoveResult (TimeValue timeout=TIMEVALUE_INFINITE, WAITMODE mode=WAITMODE::DEFAULT)
     
    - Public Member Functions inherited from JobInterface
    JOBOPTIONFLAGS GetJobOptions () const
     
    const Char * GetName () const
     
     JobInterface (const JobInterfaceJumpTablePOD &jmpTable)
     
     ~JobInterface () override
     
     JobInterface (JobInterface &&src)
     
    JobInterface & operator= (JobInterface &&src)
     
    Bool Wait (TimeValue timeout=TIMEVALUE_INFINITE, WAITMODE mode=WAITMODE::DEFAULT) const
     
    Result< void > GetResult (TimeValue timeout=TIMEVALUE_INFINITE, WAITMODE mode=WAITMODE::DEFAULT) const
     
    Result< void > MoveResult (TimeValue timeout=TIMEVALUE_INFINITE, WAITMODE mode=WAITMODE::DEFAULT)
     
    void Cancel ()
     
    Bool IsCancelled () const
     
    void CancelAndWait (WAITMODE mode=WAITMODE::DEFAULT)
     
    JobInterface * Enqueue (JobQueueInterface *queue=JOBQUEUE_CURRENT)
     
    Result< void > AddSubJob (JobInterface *subJob)
     
    template<typename JOB >
    Result< void > AddSubJob (ResultMemT< JOB * > subJob)
     
    template<typename JOBREF >
    Result< void > AddSubJob (ResultMemT< JOBREF > &&subJob)
     
    template<typename GROUP >
    Result< void > AddSubGroup (GROUP *subGroup)
     
    template<typename GROUP >
    Result< void > AddSubGroup (ResultMemT< GROUP * > subGroup)
     
    template<typename GROUP >
    Result< void > AddSubGroup (ResultMemT< GROUP > subGroup)
     
    JobGroupInterface * GetJobGroup () const
     
    ObservableFinishedBase< JobInterface > ObservableFinished ()
     
    ObservableCancelledBase< JobInterface > ObservableCancelled ()
     
    Result< void > Then (JobInterface *next, JobQueueInterface *queue=JOBQUEUE_CURRENT)
     
    String ToString (const FormatStatement *formatStatement=nullptr) const
     

    Static Public Member Functions

    static ResultMemT< PromiseRef< T > > Create ()
     
    - Static Public Member Functions inherited from JobInterfaceTemplate< Promise< T >, T >
    static ResultMemT< JobResultRef< T > > Create (ARGS &&... args)
     
    - Static Public Member Functions inherited from JobInterface
    template<JOBCANCELLATION B = JOBCANCELLATION::AUTOMATIC, typename FN , typename... ARGS>
    static ResultMemT< JobInterface * > Create (FN &&src, ARGS &&... args)
     
    static Int GetCurrentWorkerThreadIndex ()
     
    static Int GetCurrentThreadCount ()
     
    static Bool IsCurrentJobCancelled (const JobInterface *optionalJob=nullptr)
     
    static JobStatusInterface * GetCurrentJob ()
     

    Protected Member Functions

    template<typename... ARGS>
    void MoveValue (ARGS &&... args)
     
    - Protected Member Functions inherited from JobResultInterface< RESULTVALUETYPE >
    ResultOk< void > SetResult (RESULTVALUETYPE &&value)
     
    RESULTVALUETYPE & GetResultValue ()
     
    template<typename FN , typename... ARGS>
    Result< void > Invoke (FN &&obj, ARGS &&... args)
     

    Friends

    template<typename >
    class PromiseRef
     

    Additional Inherited Members

    - Protected Types inherited from JobResultInterface< RESULTVALUETYPE >
    using ValueType = RESULTVALUETYPE
     

    Member Function Documentation

    ◆ Create()

    static ResultMemT<PromiseRef<T> > Create ( )
    		static

    Creates a promise and returns.

    ◆ operator()()

    Result<void> operator() ( )

    ◆ MoveValue()

    void MoveValue ( ARGS &&...  args)
    		protected

    Move assigns the promise value.

    Friends And Related Function Documentation

    ◆ PromiseRef

    friend class PromiseRef
    		friend