Name 

Description 

Functions 

The following table lists functions in this documentation. 

Structs, Records, Enums 

The following table lists structs, records, enums in this documentation. 

Types 

The following table lists types in this documentation. 

Macros 

The following table lists macros in this documentation. 

 

Name 

Description 

 

AddTimerExx 

Adds a new periodic timer. From now, until the timer is removed with RemoveTimer, it will call the timer procedure at the specified frequency of milliseconds. The delay until the first time the timer fires can be specified independant of frequency. If it is not specified, the first time the timer will get invoked is at +1 frequency from now. 

 

ChangeTimerEx 

Changes the frequency of a timer. Reschedule timer only changes the next time it fires, this can adjust the frequency. The simple ChangeTimer macro is sufficient. 

 

DeleteCriticalSec 

Does nothing. There are no extra resources required for critical sections, and the memory is allocated by the application. 

 

EndThread 

TIMER_PROC( void, WakeThread )( PTHREAD thread ); 

 

EnterCriticalSecEx 

Enter a critical section. Only a single thread may be in a critical section, if a second thread attempts to enter the section while another thread is in it will block until the original thread leaves the section. The same thread may enter a critical section multiple times. For each time a critical section is entered, the thread must also leave the critical section (See LeaveCriticalSection). 

 

EnterCriticalSecNoWaitEx 

attempts to enter the critical section, and does not block. 

 

GetThisThreadID 

returns the numeric THREAD_ID from a PTHREAD. 

 

GetThreadID 

returns the numeric THREAD_ID from a PTHREAD. 

 

GetThreadParam 

This returns the parameter passed as user data to ThreadTo. 

 

InitializeCriticalSec 

attempts to enter the critical section, and does not block. 

 

IsThisThreadEx 

This tests to see if a pointer to a thread references the current thread. 

 

LeaveCriticalSecEx 

Leaves a critical section. See EnterCriticalSecEx. 

 

MakeThread 

Returns a PTHREAD that represents the current thread. This can be used to create a PTHREAD identifier for the main thread. 

 

RemoveTimer 

Stops a timer. The next time this timer would run, it will be removed. If it is currently dispatched, it is safe to remove from within the timer itself. 

 

RescheduleTimer 

Reschedule when a timer can fire. The delay can be 0 to make wake the timer. 

 

RescheduleTimerEx 

Reschedule when a timer can fire. The delay can be 0 to make wake the timer. 

 

TestWakeThread 

This can be checked to see if the PTHREAD to wake still has an event. Sometimes threads call UnmakeThread(). This is a more practical test using a THREAD_ID instead. See TestWakeThreadID. 

 

TestWakeThreadID 

This can be checked to see if the THREAD_ID to wake still has an event. Sometimes threads end. 

 

ThreadToEx 

Create a separate thread that starts in the routine specified. The PTRSZVAL value (something that might be a pointer), is passed in the PTHREAD structure. (See GetThreadParam) 

 

ThreadToSimpleEx 

Create a separate thread that starts in the routine specified. The PTRSZVAL value (something that might be a pointer), is passed in the PTHREAD structure. (See GetThreadParam) 

 

UnmakeThread 

Releases resources associated with a PTHREAD. For purposes of waking a thread, and providing a wakeable point for the thread, a system blocking event object is allocated, named with the THREAD_ID so it can be referenced by other processes. This is only allowed to be done by the thread itself. 

 

WakeableSleep 

Sleeps a number of milliseconds or until the thread is passed to WakeThread. 

 

WakeableSleepEx 

Sleeps a number of milliseconds or until the thread is passed to WakeThread. 

 

WakeThreadEx 

Wake a thread. 

 

WakeThreadIDEx 

Wake a thread by ID, if the pThread is not available. Can be used cross-process for instance. Although someone could add a method to provide a PTHREAD wrapper around THREAD_ID for threads in remote processes, this may not be a best practice. 

Name 

Description 

AddTimer 

Adds a new periodic timer. From now, until the timer is removed with RemoveTimer, it will call the timer procedure at the specified frequency of milliseconds. The delay until the first time the timer fires can be specified independant of frequency. If it is not specified, the first time the timer will get invoked is at +1 frequency from now. 

AddTimerEx 

Adds a new periodic timer. From now, until the timer is removed with RemoveTimer, it will call the timer procedure at the specified frequency of milliseconds. The delay until the first time the timer fires can be specified independant of frequency. If it is not specified, the first time the timer will get invoked is at +1 frequency from now. 

ChangeTimer 

Changes the frequency of a timer. Reschedule timer only changes the next time it fires, this can adjust the frequency. The simple ChangeTimer macro is sufficient. 

EnterCriticalSec 

Enter a critical section. Only a single thread may be in a critical section, if a second thread attempts to enter the section while another thread is in it will block until the original thread leaves the section. The same thread may enter a critical section multiple times. For each time a critical section is entered, the thread must also leave the critical section (See LeaveCriticalSection). 

EnterCriticalSecNoWait 

This is macro sack::timers::EnterCriticalSecNoWait. 

InitializeCriticalSection 

A custom implementation of windows CRITICAL_SECTION api. Provides same capability for Linux type systems. Can be checked as a study in how to implement safe locks.
 

IsThisThread 

This tests to see if a pointer to a thread references the current thread. 

LeaveCriticalSec 

Leaves a critical section. See EnterCriticalSecEx. 

SLEEP_FOREVER 

Symbol defined to pass to Wakeable_Sleep to sleep until someone calls WakeThread. 

ThreadTo 

Create a separate thread that starts in the routine specified. The PTRSZVAL value (something that might be a pointer), is passed in the PTHREAD structure. (See GetThreadParam) 

ThreadToSimple 

Create a separate thread that starts in the routine specified. The PTRSZVAL value (something that might be a pointer), is passed in the PTHREAD structure. (See GetThreadParam) 

TIMER_PROC 

Defines import export and call method for timers. Looks like timers are native calltype by default instead of CPROC. 

WakeThread 

Wake a thread. 

WakeThreadID 

Wake a thread by ID, if the pThread is not available. Can be used cross-process for instance. Although someone could add a method to provide a PTHREAD wrapper around THREAD_ID for threads in remote processes, this may not be a best practice. 

 

Name 

Description 

 

critical_section_tag 

A custom implementation of windows CRITICAL_SECTION api. Provides same capability for Linux type systems. Can be checked as a study in how to implement safe locks.
 

Name 

Description 

CRITICALSECTION 

A custom implementation of windows CRITICAL_SECTION api. Provides same capability for Linux type systems. Can be checked as a study in how to implement safe locks.
 

PCRITICALSECTION 

This is type sack::timers::PCRITICALSECTION. 

PTHREAD 

This is the type returned by MakeThread, and passed to ThreadTo. This is a private structure, and no definition is publicly available, this should be treated like a handle. 

ThreadSimpleStartProc 

Function signature for a thread entry point passed to ThreadToSimple. 

ThreadStartProc 

Function signature for a thread entry point passed to ThreadTo. 

TimerCallbackProc 

Function signature for user callbacks passed to AddTimer.