---

MousePipe Class Reference

A server for sending mouseMessage to VCC. More...

#include <MousePipe.h>

Inherits PServer.

List of all members.

Public Methods
bool	queueMessage (const int, const int, const int)
virtual void	disconnect ()
virtual bool	serve ()
	MousePipe (const TString &name)
virtual	~MousePipe ()
Private Types
typedef MousePipe::mouseMessage	mouseMessage
	The message sent over a mouse pipe. More...
Private Attributes
TString	semName
	The semaphore name.
HANDLE	numberInQueue
	Handle to the actual semaphore.

---

Detailed Description

This class implements a queue on the pipe. The queue is stored 'on' the pipe and is orchestrated using a semaphore.

Definition at line 20 of file MousePipe.h.

---

Member Typedef Documentation

typedef struct MousePipe::mouseMessage MousePipe::mouseMessage [private]

The message sent to VCC consits of x, y co-ordinates and the button state.

---

Constructor & Destructor Documentation

MousePipe::MousePipe (  const TString &    name )

Parameters: name  : A TString used to generate unique names for the various kernel objects Definition at line 34 of file MousePipe.cpp. References BUFFER_SIZE, numberInQueue, and semName. :PServer(TString( TEXT("Mouse") ) + name, true, BUFFER_SIZE) { semName = TString( TEXT("MOUSESEM") ) + name; numberInQueue = NULL; }

MousePipe::~MousePipe (    )  [virtual]

Object Destructor Definition at line 44 of file MousePipe.cpp. References numberInQueue. { if(numberInQueue != NULL) CloseHandle(numberInQueue); }

---

Member Function Documentation

void MousePipe::disconnect (    )  [virtual]

Calls PServer::disconnect() and removes the semaphore. See documentation for PServer. Reimplemented from PServer. Definition at line 110 of file MousePipe.cpp. References PServer::disconnect(), and numberInQueue. Referenced by serve(). { PServer::disconnect(); if(numberInQueue != NULL) CloseHandle(numberInQueue); }

bool MousePipe::queueMessage (  const int    x, const int    y, const int    buttonState )

Queues a mouseMessage to the pipe Parameters: x  : The x co-ordinate y  : The y co-ordinate buttonState  : 0 = button down, 1 = button up Returns: bool : true iff message was queued to the pipe Definition at line 61 of file MousePipe.cpp. References MousePipe::mouseMessage::button, Pipe::hPipe, PServer::isConnected(), numberInQueue, MousePipe::mouseMessage::x, and MousePipe::mouseMessage::y. Referenced by registerMouse(). { if( !isConnected() ){ return false; } mouseMessage msg; msg.x = x; msg.y = y; msg.button = buttonState; DWORD bytesWritten; if( ReleaseSemaphore(numberInQueue, 1, NULL) ){ // WriteFile will return very quickly since there is space in the buffer return WriteFile(hPipe, &msg, sizeof(mouseMessage), &bytesWritten, NULL) ? bytesWritten == sizeof(mouseMessage) : false; } else { // no space in buffer return false; } }

bool MousePipe::serve (    )  [virtual]

Calls PServer::serve() and if successful creates a semaphore. See documentation for PServer. Reimplemented from PServer. Definition at line 86 of file MousePipe.cpp. References disconnect(), numberInQueue, QUEUE_LENGTH, semName, and PServer::serve(). Referenced by Connect(). { if( !PServer::serve() ) { return false; } else { numberInQueue = CreateSemaphore( NULL, // default security 0, // initial count ie 0 messages in pipe QUEUE_LENGTH, // maximum count semName); if(numberInQueue == NULL){ disconnect(); return false; } return true; } }

---

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

• MousePipe.h
• MousePipe.cpp

---