---

PServer Class Reference

A pipe server class. More...

#include <PServer.h>

Inherits Pipe.

Inherited by MousePipe, and ScreenPipe.

List of all members.

Public Methods
HANDLE	getConnectedEventHandle ()
DWORD	getAttemptConnectResult () const
bool	isConnected ()
	Returns true if the server is connected to a client. More...
virtual bool	serve ()
virtual void	disconnect ()
	Disconnects the pipe from the client. More...
	PServer (const TString &, const bool, const DWORD=0)
virtual	~PServer ()
Static Private Methods
DWORD WINAPI	waitForClient (LPVOID)
Private Attributes
HANDLE	hConnectThread
	Handle to the connection thread. Exit code determines connection attept success.
DWORD	in
	The inbound buffer size.
DWORD	out
	The outbound buffer size.
volatile bool	connected
	Boolean indicating last known connection state.

---

Detailed Description

Handles the serving and disconnection of a Pipe. This is meant for use in a win32 program i.e. not a VCC model

Definition at line 22 of file PServer.h.

---

Constructor & Destructor Documentation

PServer::PServer (  const TString &    name, const bool    isOut, const DWORD    bufferSize = 0 )

Constructor Parameters: name  : A TString from which the pipe name is derived isOut  : Boolean, true if this is an outgoing pipe bufferSize  : Size of the outgoing buffer. MS documentation seems to be inacurate and the actual buffer size allocated is a factor of this value Definition at line 22 of file PServer.cpp. References connected, hConnectThread, in, and out. : Pipe( name, isOut ) { hConnectThread = NULL; connected = false; if( isOutbound ){ in = 0; out = bufferSize; } else { in = bufferSize; out = 0; } }

PServer::~PServer (    )  [virtual]

Object Destructor Definition at line 40 of file PServer.cpp. References disconnect(), and hConnectThread. { disconnect(); if(hConnectThread != NULL) CloseHandle(hConnectThread); }

---

Member Function Documentation

void PServer::disconnect (    )  [virtual]

Disconnects the server end of a pipe and resets the clients stay connected event. If the pipe is still waiting for a client the thread is terminated. Reimplemented from Pipe. Reimplemented in MousePipe. Definition at line 57 of file PServer.cpp. References Pipe::clientStayConnected, connected, getAttemptConnectResult(), hConnectThread, Pipe::hPipe, PS_CANCELLED, and PS_WAITING. Referenced by MousePipe::disconnect(), isConnected(), ScreenPipe::readError(), and ~PServer(). { if( getAttemptConnectResult() == PS_WAITING ) { TerminateThread(hConnectThread, PS_CANCELLED); connected = false; } connected = false; DisconnectNamedPipe(hPipe); CloseHandle(hPipe); ResetEvent(clientStayConnected); }

DWORD PServer::getAttemptConnectResult (    )  const

Returns the result of a connection attept Definition at line 170 of file PServer.cpp. References hConnectThread. Referenced by disconnect(). { DWORD exitCode; GetExitCodeThread(hConnectThread, &exitCode); return exitCode; }

HANDLE PServer::getConnectedEventHandle (    )

Produces a handle to an Event Obect that becomes sigalled when a client connects Definition at line 148 of file PServer.cpp. References hConnectThread. Referenced by Connect(). { HANDLE rtrn; // The thread handle can be used as an event object. // becomes signalled when the thread stops running DuplicateHandle( GetCurrentProcess(), hConnectThread, // handle to duplicate GetCurrentProcess(), &rtrn, // duplicate handle SYNCHRONIZE, // handle can only be used to wait on false, // non inheritable 0); // no extra options return rtrn; }

bool PServer::isConnected (    )

The makes sure the client is not wanting to disconnect, disconnecting as necessary. This should be called each time before a pipe operation is conducted. Definition at line 185 of file PServer.cpp. References Pipe::clientStayConnected, connected, and disconnect(). Referenced by Cls_OnLButtonDown(), Cls_OnLButtonUp(), MousePipe::queueMessage(), and serve(). { if( WaitForSingleObject(clientStayConnected, 0) == WAIT_OBJECT_0 ){ this->disconnect(); } return connected; }

bool PServer::serve (    )  [virtual]

Serves a Pipe and starts a thread to wait for a client Returns: bool : true iff pipe is open for clients Reimplemented in MousePipe. Definition at line 77 of file PServer.cpp. References hConnectThread, Pipe::hPipe, in, isConnected(), Pipe::isOutbound, out, Pipe::pipeName, Pipe::serverStayConnected, and waitForClient(). Referenced by Connect(), and MousePipe::serve(). { if( PServer::isConnected() ){ return true; } if( WaitForSingleObject(serverStayConnected, 0) == WAIT_OBJECT_0 ){ return false; // Client yet to process disconnect request } hPipe = CreateNamedPipe( pipeName, // pipe name isOutbound ? PIPE_ACCESS_OUTBOUND : PIPE_ACCESS_INBOUND, // pipe open mode 0, // Byte mode, blocking operations 1, // Maximum pipe Instances out, // output buffer size in, // input buffer size NMPWAIT_WAIT_FOREVER, // default time-out interval NULL); // Default Security, non inheritable if( GetLastError() == ERROR_ALREADY_EXISTS ) { CloseHandle(hPipe); // Close duplicated handle hPipe = INVALID_HANDLE_VALUE; } if ( hPipe == INVALID_HANDLE_VALUE ) { return false; } if(hConnectThread != NULL) CloseHandle(hConnectThread); hConnectThread = chBEGINTHREADEX( NULL, // Default Security, non inheritable 0, // use default stack size &waitForClient, // thread function this, // thread argument 0, // use default creation flags NULL); // don't need thread identifier if(hConnectThread == NULL){ CloseHandle(hPipe); return false; } return true; }

DWORD WINAPI PServer::waitForClient (  LPVOID    param )  [static, private]

Thread function which is blocked until client connects Definition at line 127 of file PServer.cpp. References connected, Pipe::hPipe, PS_CONNECTED, and PS_FAILED. Referenced by serve(). { PServer* server = (PServer*) param; // Wait for the client to connect; if it succeeds, // the function returns a nonzero value. If the function returns // zero, GetLastError returns ERROR_PIPE_CONNECTED. server->connected = ConnectNamedPipe(server->hPipe, NULL) ? true : (GetLastError() == ERROR_PIPE_CONNECTED); if( server->connected ){ return PS_CONNECTED; } else { return PS_FAILED; } }

---

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

• PServer.h
• PServer.cpp

---