DirectOutput
DirectOutput framework R3 for virtual pinball cabinets.
Loading...
Searching...
No Matches
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.
void RecordException (Exception Exception)
 Adds a captured exception to the Expeptions list.
void HeartBeat ()
 HeartBeat has to be called regularely to update the LastHeartBeat property.
 ThreadInfo (Thread Thread)
 Initializes a new instance of the ThreadInfo class.
 ThreadInfo ()
 Initializes a new instance of the ThreadInfo class for the thread creating the instance.

Protected Member Functions

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

Properties

IList< Exception > Exceptions [get]
 Gets a list of the last 30 exceptions which have been recorded using the RecordException method.
string HostName [get, set]
 Gets or sets the name of the object hosting the thread.
Thread Thread [get, set]
 Gets or sets the thread for which this object return information.
DateTime LastHeartBeat [get]
 Gets the timestamp of the last heartbeat.
int HeartBeatTimeOutMs [get, set]
 Gets or sets the heartbeat timeout in milliseconds.

string ThreadName [get]
 Gets the name of the thread.
bool IsAlive [get]
 Gets a value indicating whether the thread represented by this instance is alive.<be>

Detailed Description

This object provides information on a thread.

Constructor & Destructor Documentation

◆ ThreadInfo() [1/2]

DirectOutput.General.ThreadInfo.ThreadInfo ( Thread Thread)

Initializes a new instance of the ThreadInfo class.

Parameters
ThreadThe thread for which the ThreadInfo object is created.

◆ ThreadInfo() [2/2]

DirectOutput.General.ThreadInfo.ThreadInfo ( )

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

Member Function Documentation

◆ Dispose() [1/2]

void DirectOutput.General.ThreadInfo.Dispose ( )

Cleans up the resources used by instances of this class.

◆ Dispose() [2/2]

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.

◆ HeartBeat()

void DirectOutput.General.ThreadInfo.HeartBeat ( )

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

◆ RecordException()

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

Adds a captured exception to the Expeptions list.

Parameters
ExceptionThe captured exception.

Property Documentation

◆ Exceptions

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.

◆ HeartBeatTimeOutMs

int DirectOutput.General.ThreadInfo.HeartBeatTimeOutMs
getset

Gets or sets the heartbeat timeout in milliseconds.

The heartbeat timeout in milliseconds.

◆ HostName

string DirectOutput.General.ThreadInfo.HostName
getset

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

The name of the host object.

◆ IsAlive

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.

◆ LastHeartBeat

DateTime DirectOutput.General.ThreadInfo.LastHeartBeat
get

Gets the timestamp of the last heartbeat.

The last heart beat timestamp.

◆ Thread

Thread DirectOutput.General.ThreadInfo.Thread
getset

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

The thread.

◆ ThreadName

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:
  • D:/a/DirectOutput/DirectOutput/DirectOutput/General/ThreadInfo.cs