Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small refactoring in wxFileSystemWatcher MSW implementation.

Browse Source 
Make wxIOCPService::GetStatus() smarter about its return value, it makes sense
to encapsulate the convention used to indicate the thread exit condition
inside wxIOCPService class itself instead of sharing it between it
wxIOCPThread itself.

It will also make it easier to detect more detailed error conditions in this
code.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76185 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2014-03-23 00:57:00 +00:00
parent 62efdabbb8
commit 305e766f0f
2 changed files with 37 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
include/wx/msw/private/fswatcher.h
View File

@@ -206,6 +206,7 @@ public:
{ {
wxCHECK_MSG( m_iocp != INVALID_HANDLE_VALUE, false, "IOCP not init" ); wxCHECK_MSG( m_iocp != INVALID_HANDLE_VALUE, false, "IOCP not init" );
// The special values of 0 will make GetStatus() return Status_Exit.
int ret = PostQueuedCompletionStatus(m_iocp, 0, 0, NULL); int ret = PostQueuedCompletionStatus(m_iocp, 0, 0, NULL);
if (!ret) if (!ret)
{ {
@@ -215,25 +216,41 @@ public:
return ret != 0; return ret != 0;
} }
// Possible return values of GetStatus()
enum Status
{
// Status successfully retrieved into the provided arguments.
Status_OK,
// Special status indicating that we should exit retrieved.
Status_Exit,
// Some error occurred.
Status_Error
};
// Wait for completion status to arrive. // Wait for completion status to arrive.
// This function can block forever in it's wait for completion status. // This function can block forever in it's wait for completion status.
// Use PostEmptyStatus() to wake it up (and end the worker thread) // Use PostEmptyStatus() to wake it up (and end the worker thread)
bool GetStatus(unsigned long* count, wxFSWatchEntryMSW** watch, Status
OVERLAPPED** overlapped) GetStatus(unsigned long* count, wxFSWatchEntryMSW** watch,
OVERLAPPED** overlapped)
{ {
wxCHECK_MSG( m_iocp != INVALID_HANDLE_VALUE, false, "IOCP not init" ); wxCHECK_MSG( m_iocp != INVALID_HANDLE_VALUE, Status_Error,
wxCHECK_MSG( count != NULL, false, "Null out parameter 'count'"); "Invalid IOCP object" );
wxCHECK_MSG( watch != NULL, false, "Null out parameter 'watch'"); wxCHECK_MSG( count && watch && overlapped, Status_Error,
wxCHECK_MSG( overlapped != NULL, false, "Output parameters can't be NULL" );
"Null out parameter 'overlapped'");
int ret = GetQueuedCompletionStatus(m_iocp, count, (ULONG_PTR *)watch, int ret = GetQueuedCompletionStatus(m_iocp, count, (ULONG_PTR *)watch,
overlapped, INFINITE); overlapped, INFINITE);
if (!ret) if ( ret != 0 )
{ {
wxLogSysError(_("Unable to dequeue completion packet")); return *count || *watch || *overlapped ? Status_OK : Status_Exit;
} }
return ret != 0;
wxLogSysError(_("Unable to dequeue completion packet"));
return Status_Error;
} }
protected: protected:

15
src/msw/fswatcher.cpp
View File

@@ -224,12 +224,17 @@ bool wxIOCPThread::ReadEvents()
unsigned long count = 0; unsigned long count = 0;
wxFSWatchEntryMSW* watch = NULL; wxFSWatchEntryMSW* watch = NULL;
OVERLAPPED* overlapped = NULL; OVERLAPPED* overlapped = NULL;
if (!m_iocp->GetStatus(&count, &watch, &overlapped)) switch ( m_iocp->GetStatus(&count, &watch, &overlapped) )
return true; // error was logged already, we don't want to exit {
case wxIOCPService::Status_OK:
break; // nothing special to do, continue normally
// this is our exit condition, so we return false case wxIOCPService::Status_Error:
if (!count && !watch && !overlapped) return true; // error was logged already, we don't want to exit
return false;
case wxIOCPService::Status_Exit:
return false; // stop reading events
}
// if the thread got woken up but we got an empty packet it means that // if the thread got woken up but we got an empty packet it means that
// there was an overflow, too many events and not all could fit in // there was an overflow, too many events and not all could fit in