threader.h File Reference

#include "tinetype.h"

Functions
TINE_EXPORT void	SystemKillCycleTimer (void)
	Stops the TINE engine 'cycler' thread. More...
TINE_EXPORT void	SystemStartCycleTimer (void)
	Starts a TINE engine 'cycler' running (SystemCycle()) in a separate thread. More...
TINE_EXPORT void	SystemWaitCycleTimer (void)
	Waits for the TINE engine 'cycler' thread to stop running. More...

Detailed Description

thread-specific definitions and prototypes.

Function Documentation

SystemKillCycleTimer()

TINE_EXPORT void SystemKillCycleTimer

(

void

)

Stops the TINE engine 'cycler' thread.

Available in multi-threaded shared-library builds, this routine stops the separate thread where SystemCycle() runs in a tight loop (started via a call to SystemSetCycleTimer().

See also

SystemStartCycleTimer().

SystemStartCycleTimer()

TINE_EXPORT void SystemStartCycleTimer

(

void

)

Starts a TINE engine 'cycler' running (SystemCycle()) in a separate thread.

Available in multi-threaded shared-library builds, this routine starts a separate thread where SystemCycle() is allowed to run in a tight loop. Only one instance of the cycler thread is allowed to run in a single process. On windows systems, the thread will also see to it that windows messages are allowed to be processed.

Note

The Windows DLLs (tine32.dll or tine64.dll) include the cycler routines but does not start the cycler when the DLL is loaded unless the environment variable TINE_START_CYCLER = TRUE is set. Supplementary libraries such as 'tbufsrv' or ACOP will however start the cycler automatically. The call SystemSetCycleTimer() can be called more than once, but has no effect if the cycler is already running. When the shared library libtinemt.so is linked against, the routine is automatically called when the library is loaded, but ONLY if either a) the library is built with -DTINE_START_CYCLER=TRUE or if the environment variable TINE_START_CYCLER = TRUE is set. Builds using the static libraries, tinemt.lib (WINDOWS) or libtinemt.a (UNIX) will need to include tcycler.c in the project in order to make use of this routine.

use caution setting a global environment variable TINE_START_CYCLER as that might impact all TINE processes, including those which might want to manage their own cycling.

The developer is always at liberty to manage SystemCycle() in any manner he sees fit. and to, for instance, include other tasks which need to be cycled over together in the same managed loop. However, it should be guaranteed that SystemCycle() runs in a single thread per process.

See also

SystemKillCycleTimer().

SystemWaitCycleTimer()

TINE_EXPORT void SystemWaitCycleTimer

(

void

)

Waits for the TINE engine 'cycler' thread to stop running.

Available in multi-threaded shared-library builds, this routine waits for the cycler thread to stop running before continuing.

See also

SystemStartCycleTimer().