rom/exec/childorphan.c

   1 /*
   2     Copyright © 1995-2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Make any children of ThisTask task orphans.
   6     Lang: english
   7 */
   8 #include "exec_intern.h"
   9 #include "exec_util.h"
  10 #include <proto/exec.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15
  16         AROS_LH1(ULONG, ChildOrphan,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(ULONG, tid, D0),
  20
  21 /*  LOCATION */
  22         struct ExecBase *, SysBase, 124, Exec)
  23
  24 /*  FUNCTION
  25         ChildOrphan() will detach the specified task from the its parent
  26         task child task tree. This is useful if the parent task will be
  27         exiting, and no longer needs to be told about child task events.
  28
  29         Note that the default Task finaliser will orphan any remaining
  30         children when the task exits. This function can be used if you just
  31         do not wish to be told about a particular task.
  32
  33     INPUTS
  34         tid     --  The ID of the task to orphan, or 0 for all tasks. Note
  35                     that it is NOT the pointer to the task.
  36
  37     RESULT
  38         Will return 0 on success or CHILD_* on an error.
  39
  40         The child/children will no longer participate in child task
  41         actions.
  42
  43     NOTES
  44
  45     EXAMPLE
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51     INTERNALS
  52
  53 *****************************************************************************/
  54 {
  55     AROS_LIBFUNC_INIT
  56
  57     struct Task *ThisTask = GET_THIS_TASK;
  58     struct ETask *et, *child;
  59
  60     et = GetETask(ThisTask);
  61     if (et == NULL)
  62         return CHILD_NOTNEW;
  63
  64     if (tid == 0L)
  65     {
  66         Forbid();
  67         ForeachNode(&et->et_Children, child)
  68         {
  69             /*
  70                 Don't need to Remove(), because I'll blow away the entire
  71                 list at the end of the loop.
  72              */
  73             child->et_Parent = NULL;
  74         }
  75         NEWLIST(&et->et_Children);
  76         Permit();
  77     }
  78     else
  79     {
  80         Forbid();
  81         child = FindChild(tid);
  82         if (child != NULL)
  83         {
  84             child->et_Parent = NULL;
  85             Remove((struct Node *)child);
  86         }
  87         else
  88         {
  89             Permit();
  90             return CHILD_NOTFOUND;
  91         }
  92         Permit();
  93     }
  94     return 0;
  95
  96     AROS_LIBFUNC_EXIT
  97 } /* ChildOrphan */