DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 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...
 
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.

Constructor & Destructor Documentation

DirectOutput.General.ThreadInfo.ThreadInfo ( Thread  Thread)

Initializes a new instance of the ThreadInfo class.

Parameters
ThreadThe thread for which the ThreadInfo object is created.
DirectOutput.General.ThreadInfo.ThreadInfo ( )

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

Member Function Documentation

void DirectOutput.General.ThreadInfo.Dispose ( )

Cleans up the resources used by instances of this class.

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

Releases unmanaged and - optionally - managed resources.

Parameters
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.
void DirectOutput.General.ThreadInfo.HeartBeat ( )

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

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

Adds a captured exception to the Expeptions list.

Parameters
ExceptionThe captured exception.

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.

int DirectOutput.General.ThreadInfo.HeartBeatTimeOutMs
getset

Gets or sets the heartbeat timeout in milliseconds.

The heartbeat timeout in milliseconds.

string DirectOutput.General.ThreadInfo.HostName
getset

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

The name of the host object.

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.

DateTime DirectOutput.General.ThreadInfo.LastHeartBeat
getset

Gets the timestamp of the last heartbeat.

The last heart beat timestamp.

Thread DirectOutput.General.ThreadInfo.Thread
getset

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

The thread.

string DirectOutput.General.ThreadInfo.ThreadName
get

Gets the name of the thread.

The name of the thread.


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