CountdownEvent.c File Reference

#include <winpr/config.h>
#include <winpr/assert.h>
#include <winpr/crt.h>
#include <winpr/collections.h>

Functions
size_t	CountdownEvent_CurrentCount (wCountdownEvent *countdown)
	return the current event count of the CountdownEvent More...
size_t	CountdownEvent_InitialCount (wCountdownEvent *countdown)
	return the initial event count of the CountdownEvent More...
BOOL	CountdownEvent_IsSet (wCountdownEvent *countdown)
	return the current event state of the CountdownEvent More...
HANDLE	CountdownEvent_WaitHandle (wCountdownEvent *countdown)
	return the event HANDLE of the CountdownEvent to be used by WaitForSingleObject or WaitForMultipleObjects More...
void	CountdownEvent_AddCount (wCountdownEvent *countdown, size_t signalCount)
	add signalCount to the current event count of the CountdownEvent More...
BOOL	CountdownEvent_Signal (wCountdownEvent *countdown, size_t signalCount)
	Increase the current event signal state of the CountdownEvent. More...
void	CountdownEvent_Reset (wCountdownEvent *countdown, size_t count)
	reset the CountdownEvent More...
wCountdownEvent *	CountdownEvent_New (size_t initialCount)
	Allocte a CountdownEvent with initialCount. More...
void	CountdownEvent_Free (wCountdownEvent *countdown)
	Free a CountdownEvent. More...

Function Documentation

CountdownEvent_AddCount()

void CountdownEvent_AddCount	(	wCountdownEvent *	countdown,
		size_t	signalCount
	)

add signalCount to the current event count of the CountdownEvent

Methods Increments the CountdownEvent's current count by a specified value.

Here is the call graph for this function:

CountdownEvent_CurrentCount()

size_t CountdownEvent_CurrentCount

(

wCountdownEvent *

countdown

)

return the current event count of the CountdownEvent

C equivalent of the C# CountdownEvent Class http://msdn.microsoft.com/en-us/library/dd235708/ Properties Gets the number of remaining signals required to set the event.

Here is the call graph for this function:

CountdownEvent_Free()

void CountdownEvent_Free

(

wCountdownEvent *

countdown

)

Free a CountdownEvent.

Parameters

countdown

A pointer to a CountdownEvent, may be NULL

Here is the call graph for this function:

Here is the caller graph for this function:

CountdownEvent_InitialCount()

size_t CountdownEvent_InitialCount

(

wCountdownEvent *

countdown

)

return the initial event count of the CountdownEvent

Gets the numbers of signals initially required to set the event.

Here is the call graph for this function:

CountdownEvent_IsSet()

BOOL CountdownEvent_IsSet

(

wCountdownEvent *

countdown

)

return the current event state of the CountdownEvent

Determines whether the event is set.

Here is the call graph for this function:

CountdownEvent_New()

wCountdownEvent* CountdownEvent_New

(

size_t

initialCount

)

Allocte a CountdownEvent with initialCount.

Construction, Destruction

Here is the call graph for this function:

CountdownEvent_Reset()

void CountdownEvent_Reset	(	wCountdownEvent *	countdown,
		size_t	count
	)

reset the CountdownEvent

Resets the InitialCount property to a specified value.

CountdownEvent_Signal()

BOOL CountdownEvent_Signal	(	wCountdownEvent *	countdown,
		size_t	signalCount
	)

Increase the current event signal state of the CountdownEvent.

Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount.

Here is the call graph for this function:

CountdownEvent_WaitHandle()

HANDLE CountdownEvent_WaitHandle

(

wCountdownEvent *

countdown

)

return the event HANDLE of the CountdownEvent to be used by WaitForSingleObject or WaitForMultipleObjects

Gets a WaitHandle that is used to wait for the event to be set.