win32_event

#include <win-objects.h>

Inheritance diagram for win32_event:

Public Member Functions
	win32_event ()
	~win32_event ()
void	create (bool p_manualreset, bool p_initialstate)
HANDLE	detach ()
HANDLE	get () const
HANDLE	get_handle () const
bool	is_valid () const
void	release ()
void	set (HANDLE p_handle)
void	set_state (bool p_state)
bool	wait_for (double p_timeout_seconds)

Static Public Member Functions
static DWORD	g_calculate_wait_time (double p_seconds)
static int	g_twoEventWait (win32_event &ev1, win32_event &ev2, double timeout)
static int	g_twoEventWait (HANDLE ev1, HANDLE ev2, double timeout)
static bool	g_wait_for (HANDLE p_event, double p_timeout_seconds)

Private Member Functions
	win32_event (const win32_event &)
const win32_event &	operator= (const win32_event &)

Private Attributes
HANDLE	m_handle

Detailed Description

Definition at line 120 of file win-objects.h.

Constructor & Destructor Documentation

win32_event::win32_event ( )

inline

Definition at line 122 of file win-objects.h.

: m_handle(NULL) {}

win32_event::~win32_event ( )

inline

Definition at line 123 of file win-objects.h.

{release();}

win32_event::win32_event ( const win32_event &  )

private

Member Function Documentation

void win32_event::create	(	bool	p_manualreset,
		bool	p_initialstate
	)

Definition at line 194 of file win-objects.cpp.

                                                               {
    release();
    SetLastError(NO_ERROR);
    m_handle = CreateEvent(NULL,p_manualreset ? TRUE : FALSE, p_initialstate ? TRUE : FALSE,NULL);
    if (m_handle == NULL) throw exception_win32(GetLastError());
}

HANDLE win32_event::detach ( )

inline

Definition at line 130 of file win-objects.h.

{return pfc::replace_t(m_handle,(HANDLE)NULL);}

DWORD win32_event::g_calculate_wait_time ( double  p_seconds )

static

Definition at line 207 of file win-objects.cpp.

                                                         {
    DWORD time = 0;
    if (p_seconds> 0) {
        time = pfc::rint32(p_seconds * 1000.0);
        if (time == 0) time = 1;
    } else if (p_seconds < 0) {
        time = INFINITE;
    }
    return time;
}

int win32_event::g_twoEventWait ( win32_event &  ev1, win32_event &  ev2, double  timeout  )

static

Definition at line 254 of file win-objects.cpp.

                                                                                      {
    return g_twoEventWait( ev1.get_handle(), ev2.get_handle(), timeout );
}

int win32_event::g_twoEventWait ( HANDLE  ev1, HANDLE  ev2, double  timeout  )

static

Definition at line 240 of file win-objects.cpp.

                                                                        {
    HANDLE h[2] = {ev1, ev2};
    switch(WaitForMultipleObjects(2, h, FALSE, g_calculate_wait_time( timeout ) )) {
        default:
            pfc::crash();
        case WAIT_TIMEOUT:
            return 0;
        case WAIT_OBJECT_0:
            return 1;
        case WAIT_OBJECT_0 + 1:
            return 2;
    }
}

bool win32_event::g_wait_for ( HANDLE  p_event, double  p_timeout_seconds  )

static

Returns true when signaled, false on timeout.

Definition at line 219 of file win-objects.cpp.

                                                                    {
    SetLastError(NO_ERROR);
    DWORD status = WaitForSingleObject(p_event,g_calculate_wait_time(p_timeout_seconds));
    switch(status) {
    case WAIT_FAILED:
        throw exception_win32(GetLastError());
    default:
        throw pfc::exception_bug_check();
    case WAIT_OBJECT_0:
        return true;
    case WAIT_TIMEOUT:
        return false;
    }
}

HANDLE win32_event::get ( ) const

inline

Definition at line 128 of file win-objects.h.

{return m_handle;}

HANDLE win32_event::get_handle ( ) const

inline

Definition at line 129 of file win-objects.h.

{return m_handle;}

bool win32_event::is_valid ( ) const

inline

Definition at line 131 of file win-objects.h.

{return m_handle != NULL;}

const win32_event& win32_event::operator= ( const win32_event &  )

private

void win32_event::release

(

)

Definition at line 201 of file win-objects.cpp.

                          {
    HANDLE temp = detach();
    if (temp != NULL) CloseHandle(temp);
}

void win32_event::set ( HANDLE  p_handle )

inline

Definition at line 127 of file win-objects.h.

{release(); m_handle = p_handle;}

void win32_event::set_state

(

bool

p_state

)

Definition at line 234 of file win-objects.cpp.

                                        {
    PFC_ASSERT(m_handle != NULL);
    if (p_state) SetEvent(m_handle);
    else ResetEvent(m_handle);
}

bool win32_event::wait_for ( double  p_timeout_seconds )

inline

Returns true when signaled, false on timeout.

Definition at line 136 of file win-objects.h.

{return g_wait_for(get(),p_timeout_seconds);}

Field Documentation

HANDLE win32_event::m_handle

private

Definition at line 152 of file win-objects.h.

---

The documentation for this class was generated from the following files:

• pfc/win-objects.h
• pfc/win-objects.cpp