Blame winpr/libwinpr/utils/collections/CountdownEvent.c

Packit Service fa4841
/**
Packit Service fa4841
 * WinPR: Windows Portable Runtime
Packit Service fa4841
 * Countdown Event
Packit Service fa4841
 *
Packit Service fa4841
 * Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
Packit Service fa4841
 *
Packit Service fa4841
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service fa4841
 * you may not use this file except in compliance with the License.
Packit Service fa4841
 * You may obtain a copy of the License at
Packit Service fa4841
 *
Packit Service fa4841
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service fa4841
 *
Packit Service fa4841
 * Unless required by applicable law or agreed to in writing, software
Packit Service fa4841
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service fa4841
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service fa4841
 * See the License for the specific language governing permissions and
Packit Service fa4841
 * limitations under the License.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#ifdef HAVE_CONFIG_H
Packit Service fa4841
#include "config.h"
Packit Service fa4841
#endif
Packit Service fa4841
Packit Service fa4841
#ifdef HAVE_UNISTD_H
Packit Service fa4841
#include <unistd.h>
Packit Service fa4841
#endif
Packit Service fa4841
Packit Service fa4841
#include <winpr/crt.h>
Packit Service fa4841
Packit Service fa4841
#include <winpr/collections.h>
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * C equivalent of the C# CountdownEvent Class
Packit Service fa4841
 * http://msdn.microsoft.com/en-us/library/dd235708/
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Properties
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Gets the number of remaining signals required to set the event.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
DWORD CountdownEvent_CurrentCount(wCountdownEvent* countdown)
Packit Service fa4841
{
Packit Service fa4841
	return countdown->count;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Gets the numbers of signals initially required to set the event.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
DWORD CountdownEvent_InitialCount(wCountdownEvent* countdown)
Packit Service fa4841
{
Packit Service fa4841
	return countdown->initialCount;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Determines whether the event is set.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
BOOL CountdownEvent_IsSet(wCountdownEvent* countdown)
Packit Service fa4841
{
Packit Service fa4841
	BOOL status = FALSE;
Packit Service fa4841
Packit Service fa4841
	if (WaitForSingleObject(countdown->event, 0) == WAIT_OBJECT_0)
Packit Service fa4841
		status = TRUE;
Packit Service fa4841
Packit Service fa4841
	return status;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Gets a WaitHandle that is used to wait for the event to be set.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
HANDLE CountdownEvent_WaitHandle(wCountdownEvent* countdown)
Packit Service fa4841
{
Packit Service fa4841
	return countdown->event;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Methods
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Increments the CountdownEvent's current count by a specified value.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
void CountdownEvent_AddCount(wCountdownEvent* countdown, DWORD signalCount)
Packit Service fa4841
{
Packit Service fa4841
	EnterCriticalSection(&countdown->lock);
Packit Service fa4841
Packit Service fa4841
	countdown->count += signalCount;
Packit Service fa4841
Packit Service fa4841
	if (countdown->count > 0)
Packit Service fa4841
		ResetEvent(countdown->event);
Packit Service fa4841
Packit Service fa4841
	LeaveCriticalSection(&countdown->lock);
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service b1ea74
 * Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the
Packit Service b1ea74
 * specified amount.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
BOOL CountdownEvent_Signal(wCountdownEvent* countdown, DWORD signalCount)
Packit Service fa4841
{
Packit Service fa4841
	BOOL status;
Packit Service fa4841
	BOOL newStatus;
Packit Service fa4841
	BOOL oldStatus;
Packit Service fa4841
Packit Service fa4841
	status = newStatus = oldStatus = FALSE;
Packit Service fa4841
Packit Service fa4841
	EnterCriticalSection(&countdown->lock);
Packit Service fa4841
Packit Service fa4841
	if (WaitForSingleObject(countdown->event, 0) == WAIT_OBJECT_0)
Packit Service fa4841
		oldStatus = TRUE;
Packit Service fa4841
Packit Service fa4841
	if (signalCount <= countdown->count)
Packit Service fa4841
		countdown->count -= signalCount;
Packit Service fa4841
	else
Packit Service fa4841
		countdown->count = 0;
Packit Service fa4841
Packit Service fa4841
	if (countdown->count == 0)
Packit Service fa4841
		newStatus = TRUE;
Packit Service fa4841
Packit Service fa4841
	if (newStatus && (!oldStatus))
Packit Service fa4841
	{
Packit Service fa4841
		SetEvent(countdown->event);
Packit Service fa4841
		status = TRUE;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	LeaveCriticalSection(&countdown->lock);
Packit Service fa4841
Packit Service fa4841
	return status;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Resets the InitialCount property to a specified value.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
void CountdownEvent_Reset(wCountdownEvent* countdown, DWORD count)
Packit Service fa4841
{
Packit Service fa4841
	countdown->initialCount = count;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
/**
Packit Service fa4841
 * Construction, Destruction
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
wCountdownEvent* CountdownEvent_New(DWORD initialCount)
Packit Service fa4841
{
Packit Service fa4841
	wCountdownEvent* countdown = NULL;
Packit Service fa4841
Packit Service b1ea74
	if (!(countdown = (wCountdownEvent*)calloc(1, sizeof(wCountdownEvent))))
Packit Service fa4841
		return NULL;
Packit Service fa4841
Packit Service fa4841
	countdown->count = initialCount;
Packit Service fa4841
	countdown->initialCount = initialCount;
Packit Service fa4841
Packit Service fa4841
	if (!InitializeCriticalSectionAndSpinCount(&countdown->lock, 4000))
Packit Service fa4841
		goto fail_critical_section;
Packit Service fa4841
Packit Service fa4841
	if (!(countdown->event = CreateEvent(NULL, TRUE, FALSE, NULL)))
Packit Service fa4841
		goto fail_create_event;
Packit Service fa4841
Packit Service fa4841
	if (countdown->count == 0)
Packit Service fa4841
		if (!SetEvent(countdown->event))
Packit Service fa4841
			goto fail_set_event;
Packit Service fa4841
Packit Service fa4841
	return countdown;
Packit Service fa4841
Packit Service fa4841
fail_set_event:
Packit Service fa4841
	CloseHandle(countdown->event);
Packit Service fa4841
fail_create_event:
Packit Service fa4841
	DeleteCriticalSection(&countdown->lock);
Packit Service fa4841
fail_critical_section:
Packit Service fa4841
	free(countdown);
Packit Service fa4841
Packit Service fa4841
	return NULL;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
void CountdownEvent_Free(wCountdownEvent* countdown)
Packit Service fa4841
{
Packit Service fa4841
	if (!countdown)
Packit Service fa4841
		return;
Packit Service fa4841
Packit Service fa4841
	DeleteCriticalSection(&countdown->lock);
Packit Service fa4841
	CloseHandle(countdown->event);
Packit Service fa4841
Packit Service fa4841
	free(countdown);
Packit Service fa4841
}