src/pmc/parrotrunningthread.pmc

   1 /*
   2 Copyright (C) 2006-2008, The Perl Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/parrotrunningthread.pmc -- Represents a running Parrot Thread.
   8
   9 =head1 DESCRIPTION
  10
  11 This type represents a running parrot thread.
  12
  13 It provides the following methods:
  14     - join
  15     - detach
  16     - kill
  17
  18 Note that a running thread object becomes invalid when a thread
  19 finishes while detached or joined. Further operations on the
  20 object may have unexpected behavior, such as manipulating an
  21 unrelated thread.
  22
  23 =head2 Methods
  24
  25 =over 4
  26
  27 =cut
  28
  29 */
  30
  31 #include "parrot/parrot.h"
  32 #include "parrot/embed.h"
  33
  34 pmclass ParrotRunningThread no_ro {
  35
  36 /*
  37
  38 =item C<void init()>
  39
  40 Create a new, invalid handle to a running thread.
  41
  42 =cut
  43
  44 */
  45
  46     VTABLE void init() {
  47         PMC_int_val(SELF) = -1;
  48     }
  49
  50 /*
  51
  52 =item C<void init_pmc(PMC *tid)>
  53
  54 Create a new running thread referring to the thread with
  55 the Thread ID specified in C<tid>.
  56
  57 =cut
  58
  59 */
  60
  61     VTABLE void init_pmc(PMC *tid) {
  62         PMC_int_val(SELF) = VTABLE_get_integer(INTERP, tid);
  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         return PMC_int_val(SELF);
  77     }
  78
  79 /*
  80
  81 =item C<void set_integer_native(INTVAL new_tid)>
  82
  83 Change the thread ID we refer to to C<new_tid>.
  84
  85 */
  86
  87     VTABLE void set_integer_native(INTVAL new_tid) {
  88         PMC_int_val(SELF) = new_tid;
  89     }
  90 /*
  91
  92 =item C<METHOD join()>
  93
  94 Join the thread, returning whatever its main method returns.
  95
  96 =cut
  97
  98 */
  99     METHOD join() {
 100         PMC *ret          = pt_thread_join(INTERP, PMC_int_val(SELF));
 101
 102         /* invalidate self */
 103         PMC_int_val(SELF) = -1;
 104
 105         RETURN(PMC *ret);
 106     }
 107
 108 /*
 109
 110 =item C<METHOD detach()>
 111
 112 Detach the thread so it cannot be joined and will free its
 113 resources immediatelly when it exits.
 114
 115 =cut
 116
 117 */
 118
 119     METHOD detach() {
 120         pt_thread_detach(PMC_int_val(SELF));
 121     }
 122
 123 /*
 124
 125 =item C<METHOD kill()>
 126
 127 Terminate a running thread.
 128
 129 =cut
 130
 131 */
 132
 133     METHOD kill() {
 134         pt_thread_kill(PMC_int_val(SELF));
 135     }
 136
 137 }
 138
 139 /*
 140
 141 =back
 142
 143 =cut
 144
 145 */
 146
 147 /*
 148  * Local variables:
 149  *   c-file-style: "parrot"
 150  * End:
 151  * vim: expandtab shiftwidth=4:
 152  */