---

UpdateHandler Class Reference

An object running a separate update thread. More...

#include <UpdateHandler.h>

List of all members.

Public Methods
bool	setCapture (const TString &, const TString &, const int, const int)
	Sets capture information.
bool	setCaptureName (const TString &)
	Sets just the capture name.
bool	setCaptureDir (const TString &)
	Sets the capture directory.
bool	setCaptureLimit (const int)
	Sets the capture limit.
bool	setCaptureFrequency (const int)
	Sets the capture Frequency.
void	disableCapture ()
	Stops the capture of screen images.
bool	enableCapture ()
	Enables the capture of screen images.
const TString	getCaptureName () const
	get the capture name TString.
const TString	getCaptureDir () const
	get the capture directory TString.
int	getCaptureLimit () const
	get the capture limit.
int	getCaptureFrequency () const
	get the cpature Frequency.
void	stop (const bool=true)
bool	run ()
	UpdateHandler (ScreenPipe &, BitmapScreen &, HWND)
virtual	~UpdateHandler ()
Static Private Methods
DWORD WINAPI	update (LPVOID)
Private Attributes
HANDLE	hUpdateThread
	Handle to the update thread.
volatile bool	exit
	true when update thread should terminate.
BitmapScreen *	screen
	Pointer to the BitmapScreen.
ScreenPipe *	pipe
	Pointer to the ScreenPipe.
const HWND	hWnd
	Handle to the main window.
HANDLE	captureMutex
	A Handle to a Mutex protecting the capture details during capture.
TString	captureName
	The base name (to which the frame number is appended) of the .bmp file.
TString	captureDir
	The directory for storing the captures.
int	captureEvery
	The capture Frequency.
int	captureLimit
	The number of captures to perform.
volatile bool	capture
	Boolean indicating that screen captures should be performed.

---

Detailed Description

The updater reads new screens from the pipe and writes them to the BitmapScreen. Depending on capture settings the bitmap is also written to disk.

Definition at line 24 of file UpdateHandler.h.

---

Constructor & Destructor Documentation

UpdateHandler::UpdateHandler (  ScreenPipe &    s, BitmapScreen &    b, HWND    h )

Takes a reference to a ScreenPipe and BitmapScreen and initialises the object. Parameters: s  : The screen pipe object b  : The bitmap screen object h  : The Handle the window Definition at line 21 of file UpdateHandler.cpp. References capture, captureEvery, captureLimit, captureMutex, captureName, hUpdateThread, pipe, and screen. :hWnd(h) { pipe = &s; screen = &b; hUpdateThread = NULL; captureName = TEXT("ScreenCap_"); captureEvery = 1; captureLimit = 50; capture = false; captureMutex = CreateMutex(NULL, false, NULL); }

UpdateHandler::~UpdateHandler (    )  [virtual]

Object Destructor Definition at line 39 of file UpdateHandler.cpp. References captureMutex, hUpdateThread, and stop(). { stop(true); CloseHandle(captureMutex); CloseHandle(hUpdateThread); }

---

Member Function Documentation

bool UpdateHandler::run (    )

Starts the update thread Definition at line 53 of file UpdateHandler.cpp. References exit, hUpdateThread, and update(). Referenced by Cls_OnCommand(). { DWORD exitCode; GetExitCodeThread(hUpdateThread, &exitCode); if( exitCode == STILL_ACTIVE ) return true; exit = false; CloseHandle(hUpdateThread); hUpdateThread = chBEGINTHREADEX( NULL, // Default Security, non inheritable 0, // use default stack size &update, // thread function this, // thread argument 0, // use default creation flags NULL); // don't need thread identifier if(hUpdateThread == NULL){ return false; } return true; }

void UpdateHandler::stop (  const bool    force = true )

Stops the update thread Definition at line 83 of file UpdateHandler.cpp. References exit, and hUpdateThread. Referenced by Cls_OnCommand(), and ~UpdateHandler(). { exit = true; // Signal thread to stop DWORD exitCode; GetExitCodeThread(hUpdateThread, &exitCode); // If still active after a second terminate the thread if( force && exitCode == STILL_ACTIVE ){ if( WaitForSingleObject(hUpdateThread, 1000) == WAIT_TIMEOUT ) TerminateThread(hUpdateThread, 0); } }

DWORD WINAPI UpdateHandler::update (  LPVOID    param )  [static, private]

The update thread. Takes possesion of the capture Mutex and loops the reading of a screen buffer and possible capture of the image until told to quit. Definition at line 104 of file UpdateHandler.cpp. References capture, captureDir, captureEvery, captureLimit, captureMutex, captureName, BitmapScreen::DoneReading(), BitmapScreen::DoneWriting(), exit, BitmapScreen::getReadBuffer(), BitmapScreen::getWriteBuffer(), hWnd, VScreen::invalidate(), pipe, ScreenPipe::readToDIB(), DIBitmap::saveFile(), screen, SP_ERROR_CREATING_BITMAP, SP_INVALID_DATA, SP_NOT_CONNECTED, SP_SUCCESS, SP_UNKNOWN_ERROR, and update(). Referenced by run(), and update(). { UpdateHandler* update = (UpdateHandler*) param; WaitForSingleObject(update->captureMutex, INFINITE); if( !(!update->captureDir) ){ // not empty if( !SetCurrentDirectory(update->captureDir) ) update->capture = false; } if( !update->captureName ){ // is empty update->capture = false; } int screenNum = -1; // screenNo incremented before use int captureNum = 1; bool success; ULARGE_INTEGER freeBytes, notNeeded; DIBitmap *writeBuffer; const DIBitmap *readBuffer; DWORD readResult; while(!update->exit){ writeBuffer = update->screen->getWriteBuffer(); readResult = update->pipe->readToDIB(*writeBuffer); update->screen->DoneWriting(); switch(readResult){ case SP_SUCCESS: break; case SP_UNKNOWN_ERROR: case SP_ERROR_CREATING_BITMAP: case SP_NOT_CONNECTED: case SP_INVALID_DATA: default: return false; // Abandons mutex } update->screen->invalidate(update->hWnd); // restart loop if signaled to exit if(update->exit) continue; screenNum++; // Check that we wish to capture this screen if( !update->capture || !((screenNum % update->captureEvery) == 0) ) continue; // Check we haven't reached capture limit; if( update->captureLimit != 0 && captureNum > update->captureLimit ){ update->capture = false; continue; } readBuffer = update->screen->getReadBuffer(); // Write buffer to disk success = readBuffer->saveFile( update->captureName + TString(screenNum) + TString(TEXT(".bmp")) ); update->screen->DoneReading(); captureNum++; if( !success ){ GetDiskFreeSpaceEx(NULL, &freeBytes, &notNeeded, NULL); if(freeBytes.QuadPart < 1024 * 1024){ // less than a megabyte update->capture = false; // Stop capturing } } } ReleaseMutex(update->captureMutex); return true; }

---

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

• UpdateHandler.h
• UpdateHandler.cpp

---