docs/gst/tmpl/cothreads.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 cothreads
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 userspace threads
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Cothreads are a simple user-space method for switching between
  10 subtasks.  They're based on setjmp()/longjmp() in their current form.
  11 </para>
  12
  13 <para>
  14 Cothreads are used for loop-based elements that pull data instead
  15 of being fed with data. They can also be used to pull a specific region
  16 of data out of their src element.
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>
  21
  22 </para>
  23
  24 <!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
  25 <para>
  26 Get the current stack frame.
  27 </para>
  28
  29
  30
  31 <!-- ##### STRUCT cothread_state ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @ctx:
  37 @threadnum:
  38 @priv:
  39 @func:
  40 @argc:
  41 @argv:
  42 @flags:
  43 @sp:
  44 @jmp:
  45 @top_sp:
  46 @pc:
  47 @magic_number:
  48
  49 <!-- ##### STRUCT cothread_context ##### -->
  50 <para>
  51
  52 </para>
  53
  54
  55 <!-- ##### USER_FUNCTION cothread_func ##### -->
  56 <para>
  57 the function that will be called when the cothread starts. The function
  58 prototype is like a main() function, so you can do whatever you want with
  59 it.
  60 </para>
  61
  62 @argc: a main-like argument count
  63 @argv: a main-like array of arguments
  64 @Returns: a return code
  65
  66
  67 <!-- ##### MACRO COTHREAD_STARTED ##### -->
  68 <para>
  69 Indicates the cothread is started.
  70 </para>
  71
  72
  73
  74 <!-- ##### MACRO COTHREAD_DESTROYED ##### -->
  75 <para>
  76 Indicates the cothread is destroyed.
  77 </para>
  78
  79
  80
  81 <!-- ##### FUNCTION cothread_context_init ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION cothread_context_free ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @ctx:
  95
  96
  97 <!-- ##### FUNCTION cothread_get_private ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @thread:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION cothread_set_private ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @thread:
 112 @data:
 113
 114
 115 <!-- ##### FUNCTION cothread_create ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @ctx:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION cothread_free ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @thread:
 130
 131
 132 <!-- ##### FUNCTION cothread_setfunc ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @thread:
 138 @func:
 139 @argc:
 140 @argv:
 141
 142
 143 <!-- ##### FUNCTION cothread_stop ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @thread:
 149
 150
 151 <!-- ##### FUNCTION cothread_switch ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @thread:
 157
 158
 159 <!-- ##### FUNCTION cothread_context_get_data ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @thread:
 165 @key:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION cothread_context_set_data ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @thread:
 175 @key:
 176 @data:
 177
 178
 179 <!-- ##### FUNCTION cothread_lock ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @thread:
 185
 186
 187 <!-- ##### FUNCTION cothread_trylock ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @thread:
 193 @Returns:
 194
 195
 196 <!-- ##### FUNCTION cothread_unlock ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @thread:
 202
 203
 204 <!-- ##### FUNCTION cothread_main ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @ctx:
 210 @Returns:
 211
 212
 213 <!-- ##### FUNCTION cothread_current_main ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @Returns:
 219
 220
 221 <!-- ##### FUNCTION cothread_current ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @Returns:
 227
 228