task_signal() — Apollo

TASK_$SIGNAL                      Domain/OS                       TASK_$SIGNAL


NAME
     task_$signal - signal a task

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/task.h>

     void task_$signal(
          task_$handle_t task_handle,
          status_$t fault_status,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/task.ins.pas';

     procedure task_$signal(
          in task_handle: task_$handle_t;
          in fault_status: status_$t;
          out status: status_$t);

DESCRIPTION
     Task_$signal sends the signal specified by fault_status to the task
     specified by task_handle.  Task_$signal will activate any fault or
     clean-up handlers established by the task on task_handle to handle the
     fault specified by fault_status.  If the task is not running or has inhi-
     bited faults, it will be signaled the next time it is running with faults
     enabled.

     task_handle
          A task handle.

     fault_status
          The signal to send to the task on task_handle.  Also, the fault code
          passed to any fault or clean-up handler established to handle the
          fault.

     status
          The completion status of task_$signal.

SEE ALSO
     pfm_$intro, task_$blast, task_$create, task_$exit, task_$get_handle.
Museum
