docs/reference/glib/tmpl/threads.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Threads
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18
  19 <!-- ##### MACRO G_THREADS_ENABLED ##### -->
  20 <para>
  21
  22 </para>
  23
  24
  25
  26 <!-- ##### MACRO G_THREADS_IMPL_POSIX ##### -->
  27 <para>
  28
  29 </para>
  30
  31
  32
  33 <!-- ##### MACRO G_THREADS_IMPL_SOLARIS ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39
  40 <!-- ##### MACRO G_THREADS_IMPL_NONE ##### -->
  41 <para>
  42
  43 </para>
  44
  45
  46
  47 <!-- ##### MACRO G_THREAD_ERROR ##### -->
  48 <para>
  49
  50 </para>
  51
  52
  53
  54 <!-- ##### ENUM GThreadError ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @G_THREAD_ERROR_AGAIN:
  60
  61 <!-- ##### STRUCT GThreadFunctions ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @mutex_new:
  67 @mutex_lock:
  68 @mutex_trylock:
  69 @mutex_unlock:
  70 @mutex_free:
  71 @cond_new:
  72 @cond_signal:
  73 @cond_broadcast:
  74 @cond_wait:
  75 @cond_timed_wait:
  76 @cond_free:
  77 @private_new:
  78 @private_get:
  79 @private_set:
  80 @thread_create:
  81 @thread_yield:
  82 @thread_join:
  83 @thread_exit:
  84 @thread_set_priority:
  85 @thread_self:
  86
  87 <!-- ##### FUNCTION g_thread_init ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @vtable:
  93
  94
  95 <!-- ##### FUNCTION g_thread_supported ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @Returns:
 101
 102
 103 <!-- ##### USER_FUNCTION GThreadFunc ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @value:
 109
 110
 111 <!-- ##### ENUM GThreadPriority ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @G_THREAD_PRIORITY_LOW:
 117 @G_THREAD_PRIORITY_NORMAL:
 118 @G_THREAD_PRIORITY_HIGH:
 119 @G_THREAD_PRIORITY_URGENT:
 120
 121 <!-- ##### STRUCT GThread ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @priority:
 127 @bound:
 128 @joinable:
 129
 130 <!-- ##### FUNCTION g_thread_create ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @thread_func:
 136 @arg:
 137 @stack_size:
 138 @joinable:
 139 @bound:
 140 @priority:
 141 @error:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION g_thread_self ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION g_thread_join ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @thread:
 159
 160
 161 <!-- ##### FUNCTION g_thread_set_priority ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @thread:
 167 @priority:
 168
 169
 170 <!-- ##### MACRO g_thread_yield ##### -->
 171 <para>
 172
 173 </para>
 174
 175
 176
 177 <!-- ##### MACRO g_thread_exit ##### -->
 178 <para>
 179
 180 </para>
 181
 182
 183
 184 <!-- ##### STRUCT GMutex ##### -->
 185 <para>
 186
 187 </para>
 188
 189
 190 <!-- ##### FUNCTION g_mutex_new ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION g_mutex_lock ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @mutex:
 204
 205
 206 <!-- ##### FUNCTION g_mutex_trylock ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @mutex:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION g_mutex_unlock ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @mutex:
 221
 222
 223 <!-- ##### FUNCTION g_mutex_free ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @mutex:
 229
 230
 231 <!-- ##### STRUCT GStaticMutex ##### -->
 232 <para>
 233
 234 </para>
 235
 236
 237 <!-- ##### MACRO G_STATIC_MUTEX_INIT ##### -->
 238 <para>
 239
 240 </para>
 241
 242
 243
 244 <!-- ##### FUNCTION g_static_mutex_lock ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @mutex:
 250
 251
 252 <!-- ##### FUNCTION g_static_mutex_trylock ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @mutex:
 258 @Returns:
 259
 260
 261 <!-- ##### FUNCTION g_static_mutex_unlock ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @mutex:
 267
 268
 269 <!-- ##### FUNCTION g_static_mutex_get_mutex ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @mutex:
 275 @Returns:
 276
 277
 278 <!-- ##### MACRO G_LOCK_DEFINE ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @name:
 284
 285
 286 <!-- ##### MACRO G_LOCK_DEFINE_STATIC ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @name:
 292
 293
 294 <!-- ##### MACRO G_LOCK_EXTERN ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @name:
 300
 301
 302 <!-- ##### MACRO G_LOCK ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @name:
 308
 309
 310 <!-- ##### MACRO G_TRYLOCK ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @name:
 316
 317
 318 <!-- ##### MACRO G_UNLOCK ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @name:
 324
 325
 326 <!-- ##### STRUCT GStaticRecMutex ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @mutex:
 332 @depth:
 333 @owner:
 334
 335 <!-- ##### MACRO G_STATIC_REC_MUTEX_INIT ##### -->
 336 <para>
 337
 338 </para>
 339
 340
 341
 342 <!-- ##### FUNCTION g_static_rec_mutex_lock ##### -->
 343 <para>
 344
 345 </para>
 346
 347 @mutex:
 348
 349
 350 <!-- ##### FUNCTION g_static_rec_mutex_trylock ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @mutex:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION g_static_rec_mutex_unlock ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @mutex:
 365
 366
 367 <!-- ##### FUNCTION g_static_rec_mutex_lock_full ##### -->
 368 <para>
 369
 370 </para>
 371
 372 @mutex:
 373 @depth:
 374
 375
 376 <!-- ##### FUNCTION g_static_rec_mutex_unlock_full ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @mutex:
 382 @Returns:
 383
 384
 385 <!-- ##### STRUCT GStaticRWLock ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @mutex:
 391 @read_cond:
 392 @write_cond:
 393 @read_counter:
 394 @write:
 395 @want_to_write:
 396
 397 <!-- ##### MACRO G_STATIC_RW_LOCK_INIT ##### -->
 398 <para>
 399
 400 </para>
 401
 402
 403
 404 <!-- ##### FUNCTION g_static_rw_lock_reader_lock ##### -->
 405 <para>
 406
 407 </para>
 408
 409 @lock:
 410
 411
 412 <!-- ##### FUNCTION g_static_rw_lock_reader_trylock ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @lock:
 418 @Returns:
 419
 420
 421 <!-- ##### FUNCTION g_static_rw_lock_reader_unlock ##### -->
 422 <para>
 423
 424 </para>
 425
 426 @lock:
 427
 428
 429 <!-- ##### FUNCTION g_static_rw_lock_writer_lock ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @lock:
 435
 436
 437 <!-- ##### FUNCTION g_static_rw_lock_writer_trylock ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @lock:
 443 @Returns:
 444
 445
 446 <!-- ##### FUNCTION g_static_rw_lock_writer_unlock ##### -->
 447 <para>
 448
 449 </para>
 450
 451 @lock:
 452
 453
 454 <!-- ##### FUNCTION g_static_rw_lock_free ##### -->
 455 <para>
 456
 457 </para>
 458
 459 @lock:
 460
 461
 462 <!-- ##### STRUCT GCond ##### -->
 463 <para>
 464
 465 </para>
 466
 467
 468 <!-- ##### FUNCTION g_cond_new ##### -->
 469 <para>
 470
 471 </para>
 472
 473 @Returns:
 474
 475
 476 <!-- ##### FUNCTION g_cond_signal ##### -->
 477 <para>
 478
 479 </para>
 480
 481 @cond:
 482
 483
 484 <!-- ##### FUNCTION g_cond_broadcast ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @cond:
 490
 491
 492 <!-- ##### FUNCTION g_cond_wait ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @cond:
 498 @mutex:
 499
 500
 501 <!-- ##### FUNCTION g_cond_timed_wait ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @cond:
 507 @mutex:
 508 @abs_time:
 509 @Returns:
 510
 511
 512 <!-- ##### FUNCTION g_cond_free ##### -->
 513 <para>
 514
 515 </para>
 516
 517 @cond:
 518
 519
 520 <!-- ##### STRUCT GPrivate ##### -->
 521 <para>
 522
 523 </para>
 524
 525
 526 <!-- ##### FUNCTION g_private_new ##### -->
 527 <para>
 528
 529 </para>
 530
 531 @destructor:
 532 @Returns:
 533
 534
 535 <!-- ##### FUNCTION g_private_get ##### -->
 536 <para>
 537
 538 </para>
 539
 540 @private_key:
 541 @Returns:
 542
 543
 544 <!-- ##### FUNCTION g_private_set ##### -->
 545 <para>
 546
 547 </para>
 548
 549 @private_key:
 550 @data:
 551
 552
 553 <!-- ##### STRUCT GStaticPrivate ##### -->
 554 <para>
 555
 556 </para>
 557
 558 @index:
 559
 560 <!-- ##### MACRO G_STATIC_PRIVATE_INIT ##### -->
 561 <para>
 562
 563 </para>
 564
 565
 566
 567 <!-- ##### FUNCTION g_static_private_get ##### -->
 568 <para>
 569
 570 </para>
 571
 572 @private_key:
 573 @Returns:
 574
 575
 576 <!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
 577 <para>
 578
 579 </para>
 580
 581 @private_key:
 582 @thread:
 583 @Returns:
 584
 585
 586 <!-- ##### FUNCTION g_static_private_set ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @private_key:
 592 @data:
 593 @notify:
 594
 595
 596 <!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
 597 <para>
 598
 599 </para>
 600
 601 @private_key:
 602 @thread:
 603 @data:
 604 @notify:
 605
 606