File: al_get_thread_should_stop.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (28 lines) | stat: -rw-r--r-- 679 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.TH "al_get_thread_should_stop" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_get_thread_should_stop \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_get_thread_should_stop(ALLEGRO_THREAD\ *thread)
\f[]
.fi
.SH DESCRIPTION
.PP
Check if another thread is waiting for \f[C]thread\f[] to stop.
Threads which run in a loop should check this periodically and act on it
when convenient.
.PP
Returns true if another thread has called al_join_thread(3) or
al_set_thread_should_stop(3) on this thread.
.SH SEE ALSO
.PP
al_join_thread(3), al_set_thread_should_stop(3).
.RS
.PP
\f[I]Note:\f[] We don\[aq]t support forceful killing of threads.
.RE