SAM function SAM-Check-execution-status()

From SoOS

Jump to: navigation, search

Contents

[edit] Name

SAM_Check_execution_status - Check the execution status of a worker thread

[edit] Synopsis 

#include <sam.h>
 
SAM_Worker_status_t SAM_Check_execution_status(SAM_t sam, SAM_Workerid_t wid);

[edit] Description

The SAM_Check_execution_status() function returns the status of the worker thread wid.

Related constants:

  • SAM_WORKER_STATUS_NOTINIT
    The worker thread is not yet initialized.
  • SAM_WORKER_STATUS_PREPARED
    The worker thread is waiting for the operating system scheduler to start execution.
  • SAM_WORKER_STATUS_RUNNING
    The worker thread is executing normally.
  • SAM_WORKER_STATUS_INFB
    The worker thread is in the middle of a flash back.
  • SAM_WORKER_STATUS_HALTED
    The worker thread has been halted, and it is waiting for a manual restart.
  • SAM_WORKER_STATUS_CANCELED
    The worker thread has been cancelled.
  • SAM_WORKER_STATUS_WAITJOIN
    The worker thread has finished execution and is waiting to be joined, merge the speculative memory writing and to return the result.
  • SAM_WORKER_STATUS_FINISHED
    The worker thread has finished execution and has been joined, the speculative memory writing has been merged and result retrieved and merged.

[edit] Return value

See DESCRIPTION above.

[edit] Errors

None, assumes correct input parameters.

[edit] Examples

None.

[edit] See also

SAM_Delete_execution_info(), <sam.h>.

Retrieved from "http://www.soos-project.eu/wiki/index.php/SAM_function_SAM-Check-execution-status()"