CArchMultithreadWindows Class Reference

Win32 implementation of IArchMultithread. More...

#include <CArchMultithreadWindows.h>

Inherits IArchMultithread.

Collaboration diagram for CArchMultithreadWindows:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual CArchCond newCondVar ()
 Create a condition variable.
virtual void closeCondVar (CArchCond)
 Destroy a condition variable.
virtual void signalCondVar (CArchCond)
 Signal a condition variable.
virtual void broadcastCondVar (CArchCond)
 Broadcast a condition variable.
virtual bool waitCondVar (CArchCond, CArchMutex, double timeout)
 Wait on a condition variable.
virtual CArchMutex newMutex ()
 Create a recursive mutex.
virtual void closeMutex (CArchMutex)
 Destroy a mutex.
virtual void lockMutex (CArchMutex)
 Lock a mutex.
virtual void unlockMutex (CArchMutex)
 Unlock a mutex.
virtual CArchThread newThread (ThreadFunc, void *)
 Start a new thread.
virtual CArchThread newCurrentThread ()
 Get a reference to the calling thread.
virtual CArchThread copyThread (CArchThread)
 Copy a thread object.
virtual void closeThread (CArchThread)
 Release a thread reference.
virtual void cancelThread (CArchThread)
 Force a thread to exit.
virtual void setPriorityOfThread (CArchThread, int n)
 Change thread priority.
virtual void testCancelThread ()
 Cancellation point.
virtual bool wait (CArchThread, double timeout)
 Wait for a thread to exit.
virtual bool isSameThread (CArchThread, CArchThread)
 Compare threads.
virtual bool isExitedThread (CArchThread)
 Test if thread exited.
virtual void * getResultOfThread (CArchThread)
 Returns the exit code of a thread.
virtual ThreadID getIDOfThread (CArchThread)
 Returns an ID for a thread.
virtual void setSignalHandler (ESignal, SignalFunc, void *)
 Set the interrupt handler.
virtual void raiseSignal (ESignal)
 Invoke the signal handler.
manipulators



void setNetworkDataForCurrentThread (void *)

accessors



HANDLE getCancelEventForCurrentThread ()
void * getNetworkDataForThread (CArchThread)
static CArchMultithreadWindowsgetInstance ()

Detailed Description

Win32 implementation of IArchMultithread.

Definition at line 41 of file CArchMultithreadWindows.h.


Member Function Documentation

void CArchMultithreadWindows::broadcastCondVar ( CArchCond   )  [virtual]

Broadcast a condition variable.

Broadcasting a condition variable releases all waiting threads.

Implements IArchMultithread.

Definition at line 189 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

void CArchMultithreadWindows::cancelThread ( CArchThread  thread  )  [virtual]

Force a thread to exit.

Causes thread to exit when it next calls a cancellation point. A thread avoids cancellation as long as it nevers calls a cancellation point. Once it begins the cancellation process it must always let cancellation go to completion but may take as long as necessary to clean up.

Implements IArchMultithread.

Definition at line 366 of file CArchMultithreadWindows.cpp.

void CArchMultithreadWindows::closeThread ( CArchThread   )  [virtual]

Release a thread reference.

Deletes the given thread object. This does not destroy the thread the object referred to, even if there are no remaining references. Use cancelThread() and waitThread() to stop a thread and wait for it to exit.

Implements IArchMultithread.

Definition at line 336 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

Referenced by wait().

CArchThread CArchMultithreadWindows::copyThread ( CArchThread  thread  )  [virtual]

Copy a thread object.

Returns a reference to to thread referred to by thread.

Implements IArchMultithread.

Definition at line 359 of file CArchMultithreadWindows.cpp.

IArchMultithread::ThreadID CArchMultithreadWindows::getIDOfThread ( CArchThread  thread  )  [virtual]

Returns an ID for a thread.

Returns some ID number for thread. This is for logging purposes. All thread objects referring to the same thread return the same ID. However, clients should us isSameThread() to compare thread objects instead of comparing IDs.

Implements IArchMultithread.

Definition at line 530 of file CArchMultithreadWindows.cpp.

void * CArchMultithreadWindows::getResultOfThread ( CArchThread  thread  )  [virtual]

Returns the exit code of a thread.

Waits indefinitely for thread to exit (if it hasn't yet) then returns the thread's exit code.

(Cancellation point)

Implements IArchMultithread.

Definition at line 521 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

bool CArchMultithreadWindows::isExitedThread ( CArchThread  thread  )  [virtual]

Test if thread exited.

Returns true iff thread has exited.

Implements IArchMultithread.

Definition at line 514 of file CArchMultithreadWindows.cpp.

bool CArchMultithreadWindows::isSameThread ( CArchThread  ,
CArchThread   
) [virtual]

Compare threads.

Returns true iff two thread objects refer to the same thread. Note that comparing thread objects directly is meaningless.

Implements IArchMultithread.

Definition at line 508 of file CArchMultithreadWindows.cpp.

CArchCond CArchMultithreadWindows::newCondVar (  )  [virtual]

Create a condition variable.

The condition variable is an opaque data type.

Implements IArchMultithread.

Definition at line 153 of file CArchMultithreadWindows.cpp.

References newMutex().

CArchThread CArchMultithreadWindows::newCurrentThread (  )  [virtual]

Get a reference to the calling thread.

Returns a thread representing the current (i.e. calling) thread.

Implements IArchMultithread.

Definition at line 326 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

Referenced by CArchNetworkWinsock::pollSocket().

CArchMutex CArchMultithreadWindows::newMutex (  )  [virtual]

Create a recursive mutex.

Creates a recursive mutex. A thread may lock a recursive mutex when it already holds a lock on that mutex. The mutex is an opaque data type.

Implements IArchMultithread.

Definition at line 263 of file CArchMultithreadWindows.cpp.

Referenced by newCondVar().

CArchThread CArchMultithreadWindows::newThread ( ThreadFunc  func,
void *  userData 
) [virtual]

Start a new thread.

Creates and starts a new thread, using func as the entry point and passing it userData. The thread is an opaque data type.

Implements IArchMultithread.

Definition at line 290 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

void CArchMultithreadWindows::raiseSignal ( ESignal  signal  )  [virtual]

Invoke the signal handler.

Invokes the signal handler for signal, if any. If no handler cancels the main thread for kINTERRUPT and kTERMINATE and ignores the call otherwise.

Implements IArchMultithread.

Definition at line 546 of file CArchMultithreadWindows.cpp.

References IArchMultithread::kINTERRUPT, IArchMultithread::kTERMINATE, lockMutex(), and unlockMutex().

void CArchMultithreadWindows::setPriorityOfThread ( CArchThread  ,
int  n 
) [virtual]

Change thread priority.

Changes the priority of thread by n. If n is positive the thread has a lower priority and if negative a higher priority. Some architectures may not support either or both directions.

Implements IArchMultithread.

Definition at line 375 of file CArchMultithreadWindows.cpp.

void CArchMultithreadWindows::setSignalHandler ( ESignal  ,
SignalFunc  func,
void *  userData 
) [virtual]

Set the interrupt handler.

Sets the function to call on receipt of an external interrupt. By default and when func is NULL, the main thread is cancelled.

Implements IArchMultithread.

Definition at line 536 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

void CArchMultithreadWindows::signalCondVar ( CArchCond   )  [virtual]

Signal a condition variable.

Signalling a condition variable releases one waiting thread.

Implements IArchMultithread.

Definition at line 175 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

void CArchMultithreadWindows::testCancelThread (  )  [virtual]

Cancellation point.

This method does nothing but is a cancellation point. Clients can make their own functions cancellation points by calling this method at appropriate times.

(Cancellation point)

Implements IArchMultithread.

Definition at line 434 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().

bool CArchMultithreadWindows::wait ( CArchThread  thread,
double  timeout 
) [virtual]

Wait for a thread to exit.

Waits for up to timeout seconds for thread to exit (normally or by cancellation). Waits forever if timeout < 0. Returns true if the thread exited, false otherwise. Waiting on the current thread returns immediately with false.

(Cancellation point)

Implements IArchMultithread.

Definition at line 446 of file CArchMultithreadWindows.cpp.

References closeThread(), lockMutex(), and unlockMutex().

bool CArchMultithreadWindows::waitCondVar ( CArchCond  ,
CArchMutex  ,
double  timeout 
) [virtual]

Wait on a condition variable.

Wait on a conditation variable for up to timeout seconds. If timeout is < 0 then there is no timeout. The mutex must be locked when this method is called. The mutex is unlocked during the wait and locked again before returning. Returns true if the condition variable was signalled and false on timeout.

(Cancellation point)

Implements IArchMultithread.

Definition at line 203 of file CArchMultithreadWindows.cpp.

References lockMutex(), and unlockMutex().


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

Generated on 12 Nov 2010 for synergy-plus by  doxygen 1.6.1