DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.General.ThreadInfo Class Reference

This object provides information on a thread. More...

Inheritance diagram for DirectOutput.General.ThreadInfo:
Collaboration diagram for DirectOutput.General.ThreadInfo:

Public Member Functions

void Dispose ()
 Cleans up the resources used by instances of this class. More...
 
void RecordException (Exception Exception)
 Adds a captured exception to the Expeptions list. More...
 
void HeartBeat ()
 HeartBeat has to be called regularely to update the LastHeartBeat property. More...
 
 ThreadInfo (Thread Thread)
 Initializes a new instance of the ThreadInfo class. More...
 
 ThreadInfo ()
 Initializes a new instance of the ThreadInfo class for the thread creating the instance. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 Releases unmanaged and - optionally - managed resources. More...
 

Properties

IList< Exception > Exceptions [get]
 Gets a list of the last 30 exceptions which have been recorded using the RecordException method. More...
 
string HostName [get, set]
 Gets or sets the name of the object hosting the thread. More...
 
Thread Thread [get, set]
 Gets or sets the thread for which this object return information. More...
 
DateTime LastHeartBeat [get, set]
 Gets the timestamp of the last heartbeat. More...
 
int HeartBeatTimeOutMs [get, set]
 Gets or sets the heartbeat timeout in milliseconds.
More...
 
int ProcessorNumber [get, set]
 Gets the number of the logical processor executing the thread. More...
 
string ThreadName [get]
 Gets the name of the thread. More...
 
bool IsAlive [get]
 Gets a value indicating whether the thread represented by this instance is alive.<be> More...
 

Detailed Description

This object provides information on a thread.

Definition at line 12 of file ThreadInfo.cs.

Constructor & Destructor Documentation

DirectOutput.General.ThreadInfo.ThreadInfo ( Thread  Thread)
inline

Initializes a new instance of the ThreadInfo class.

Parameters
ThreadThe thread for which the ThreadInfo object is created.

Definition at line 174 of file ThreadInfo.cs.

DirectOutput.General.ThreadInfo.ThreadInfo ( )
inline

Initializes a new instance of the ThreadInfo class for the thread creating the instance.

Definition at line 186 of file ThreadInfo.cs.

Member Function Documentation

void DirectOutput.General.ThreadInfo.Dispose ( )
inline

Cleans up the resources used by instances of this class.

Definition at line 19 of file ThreadInfo.cs.

virtual void DirectOutput.General.ThreadInfo.Dispose ( bool  disposing)
inlineprotectedvirtual

Releases unmanaged and - optionally - managed resources.

Parameters
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.

Definition at line 30 of file ThreadInfo.cs.

void DirectOutput.General.ThreadInfo.HeartBeat ( )
inline

HeartBeat has to be called regularely to update the LastHeartBeat property.

Definition at line 99 of file ThreadInfo.cs.

void DirectOutput.General.ThreadInfo.RecordException ( Exception  Exception)
inline

Adds a captured exception to the Expeptions list.

Parameters
ExceptionThe captured exception.

Definition at line 62 of file ThreadInfo.cs.

Property Documentation

IList<Exception> DirectOutput.General.ThreadInfo.Exceptions
get

Gets a list of the last 30 exceptions which have been recorded using the RecordException method.

The list of exceptions.

Definition at line 54 of file ThreadInfo.cs.

int DirectOutput.General.ThreadInfo.HeartBeatTimeOutMs
getset

Gets or sets the heartbeat timeout in milliseconds.

The heartbeat timeout in milliseconds.

Definition at line 114 of file ThreadInfo.cs.

string DirectOutput.General.ThreadInfo.HostName
getset

Gets or sets the name of the object hosting the thread.

The name of the host object.

Definition at line 78 of file ThreadInfo.cs.

bool DirectOutput.General.ThreadInfo.IsAlive
get

Gets a value indicating whether the thread represented by this instance is alive.<be>

true if the thread is alive; otherwise, false.

Definition at line 162 of file ThreadInfo.cs.

DateTime DirectOutput.General.ThreadInfo.LastHeartBeat
getset

Gets the timestamp of the last heartbeat.

The last heart beat timestamp.

Definition at line 94 of file ThreadInfo.cs.

int DirectOutput.General.ThreadInfo.ProcessorNumber
getset

Gets the number of the logical processor executing the thread.

Note
The processor number returned by this property represents the logical processor number of the thread which has been calling the HaertBeat method last.

The logical number of the processor executing the thread.

Definition at line 128 of file ThreadInfo.cs.

Thread DirectOutput.General.ThreadInfo.Thread
getset

Gets or sets the thread for which this object return information.

The thread.

Definition at line 86 of file ThreadInfo.cs.

string DirectOutput.General.ThreadInfo.ThreadName
get

Gets the name of the thread.

The name of the thread.

Definition at line 151 of file ThreadInfo.cs.


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