src/pmc/parrotthread.pmc

   1 /*
   2 Copyright (C) 2001-2010, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/parrotthread.pmc - Represents a Parrot Thread.
   8
   9 =head1 DESCRIPTION
  10
  11 This type represents a  parrot thread.
  12
  13 It provides the following methods:
  14     - join
  15     - detach
  16     - kill
  17     - pid
  18
  19 =head2 Methods
  20
  21 =over 4
  22
  23 =cut
  24
  25 */
  26
  27 #include "parrot/embed.h"
  28
  29
  30 pmclass ParrotThread no_ro auto_attrs {
  31     ATTR INTVAL tid; /* thread id */
  32
  33 /* HEADERIZER HFILE: none */
  34 /* HEADERIZER BEGIN: static */
  35 /* HEADERIZER END: static */
  36
  37 /*
  38
  39 =item C<void init()>
  40
  41 Create a new, invalid handle to a running thread.
  42
  43 =cut
  44
  45 */
  46
  47     VTABLE void init() {
  48         VTABLE_set_integer_native(INTERP, SELF, -1);
  49     }
  50
  51 /*
  52
  53 =item C<void init_pmc(PMC *notused)>
  54
  55 Create a new, invalid handle to a running thread.
  56
  57 =cut
  58
  59 */
  60
  61     VTABLE void init_pmc(PMC *notused) {
  62         VTABLE_set_integer_native(INTERP, SELF, -1);
  63     }
  64
  65 /*
  66
  67 =item C<INTVAL get_integer()>
  68
  69 Return the thread ID of this thread.
  70
  71 =cut
  72
  73 */
  74
  75     VTABLE INTVAL get_integer() {
  76         INTVAL ttid;
  77         GETATTR_ParrotThread_tid(INTERP, SELF, ttid);
  78         return ttid;
  79     }
  80
  81     VTABLE void set_integer_native(INTVAL ttid) {
  82         SETATTR_ParrotThread_tid(INTERP, SELF, ttid);
  83     }
  84
  85
  86 /*
  87
  88 =item C<METHOD run(closure)>
  89
  90 Join the thread, returning whatever its main method returns.
  91
  92 =cut
  93
  94 */
  95     METHOD run_clone(PMC *sub, PMC *args :slurpy) {
  96         INTVAL ttid;
  97         if (PMC_IS_NULL(sub)) {
  98             Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_INVALID_OPERATION,
  99                     "Invalid thread sub");
 100         }
 101
 102         ttid = pt_thread_create_run(INTERP,
 103                                     enum_class_ThreadInterpreter, PARROT_CLONE_DEFAULT, sub, args);
 104         VTABLE_set_integer_native(INTERP, SELF, ttid);
 105     }
 106
 107     METHOD run(INTVAL clone_flags, PMC *sub, PMC *args :slurpy) {
 108         INTVAL ttid;
 109         if (PMC_IS_NULL(sub)) {
 110             Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_INVALID_OPERATION,
 111                     "Invalid thread sub");
 112         }
 113
 114         ttid = pt_thread_create_run(INTERP, enum_class_ThreadInterpreter, clone_flags, sub, args);
 115         VTABLE_set_integer_native(INTERP, SELF, ttid);
 116     }
 117 /*
 118
 119 =item C<METHOD join()>
 120
 121 Join the thread, returning whatever its main method returns.
 122
 123 =cut
 124
 125 */
 126     METHOD join() {
 127         PMC *ret;
 128         INTVAL ttid = VTABLE_get_integer(INTERP, SELF);
 129
 130         ret = pt_thread_join(INTERP, ttid);
 131         /* invalidate self */
 132         VTABLE_set_integer_native(INTERP, SELF, -1);
 133
 134         RETURN(PMC *ret);
 135     }
 136
 137 /*
 138
 139 =item C<METHOD detach()>
 140
 141 Detach the thread so it cannot be joined and will free its resources
 142 immediately when it exits.
 143
 144 =cut
 145
 146 */
 147
 148     METHOD detach() {
 149         pt_thread_detach((UINTVAL)VTABLE_get_integer(INTERP, SELF));
 150     }
 151
 152 /*
 153
 154 =item C<METHOD kill()>
 155
 156 Terminate a running thread.
 157
 158 =cut
 159
 160 */
 161
 162     METHOD kill() {
 163         pt_thread_kill((UINTVAL)VTABLE_get_integer(INTERP, SELF));
 164     }
 165
 166 }
 167
 168 /*
 169
 170 =back
 171
 172 =cut
 173
 174 */
 175
 176 /*
 177  * Local variables:
 178  *   c-file-style: "parrot"
 179  * End:
 180  * vim: expandtab shiftwidth=4:
 181  */