ThreadsInfo

java.lang.Object
- de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ThreadsInfo

All Implemented Interfaces:

Poolable<ThreadsInfo>
```
public class ThreadsInfo
extends java.lang.Object
implements Poolable<ThreadsInfo>
```
Contains information about changes in running threads between to points in time. Used also to store and transfer information on the current thread. In SPASS-monitor we distinguish between monitored running threads and remainder threads (started outside monitoring, e.g. as part of the JVM). This class is intended to store information about the monitored running threads and the aggregated information on the remainder threads.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type	Field and Description
`private long`	`currentInstanceId` Stores the current instance identifier (`0` means none).
`private long`	`currentThreadId` Stores the id of the (initially) creating thread.
`private long`	`currentThreadTicks` Stores the current time ticks of the (initially) creating thread.
`static ObjectPool<ThreadsInfo>`	`POOL` Defines an object pool for this class.

Constructor Summary

Constructors
Constructor and Description

ThreadsInfo()
Creates a new thread information object.

Constructors
Constructor and Description
`ThreadsInfo()` Creates a new thread information object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears this instance before returning it to the pool.
`ThreadsInfo`	`create()` Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).
`long`	`getCurrentInstanceId()` Returns the current instance id.
`long`	`getCurrentThreadId()` Returns the current thread id as given in the constructor.
`long`	`getCurrentThreadTicks()` Returns the time ticks consumed by the current thread as given in the constructor.
`void`	`read(java.io.DataInputStream in)` Reads this instance from a data input stream.
`static ThreadsInfo`	`readFromPool(java.io.DataInputStream in)` Obtains an instance from the object pool and reads the related data from a data input stream (convenience method).
`void`	`setCurrentThreadTicks(long currentThreadTicks)` Specifies the thread time ticks to initialize (reusable) instances.
`void`	`setIds(long currentThreadId, long currentInstanceId)` Specifies both ids to initialize (reusable) instances.
`void`	`setInstanceId(long currentInstanceId)` Specifies the instance id to initialize (reusable) instances.
`void`	`setThreadId(long currentThreadId)` Specifies the thread id to initialize (reusable) instances.
`java.lang.String`	`toString()` Returns a textual representation.
`void`	`write(java.io.DataOutputStream out)` Writes this instance to a data output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - POOL
```
public static final ObjectPool<ThreadsInfo> POOL
```
    Defines an object pool for this class. The pool size needs to be twice as large as the enter and exit pools.
  - currentThreadTicks
```
private long currentThreadTicks
```
    Stores the current time ticks of the (initially) creating thread.
  - currentThreadId
```
private long currentThreadId
```
    Stores the id of the (initially) creating thread.
  - currentInstanceId
```
private long currentInstanceId
```
    Stores the current instance identifier (0 means none).
- Constructor Detail
  - ThreadsInfo
```
ThreadsInfo()
```
    Creates a new thread information object. The specified values are for transporting and passing the current values to the receiver method (possibly over network). The parameters are not determined automatically in this constructor, because the instance creation can also be done with transmitted data on a remote machine.
    Do not call this constructor from outside as the instances of this class are pooled POOL!
    
    Since:
    
    1.00
- Method Detail
  - create
```
public ThreadsInfo create()
```
    Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).
    
    Specified by:
    
    create in interface Poolable<ThreadsInfo>
    
    Returns:
    
    the created instance
    
    Since:
    
    1.00
  - readFromPool
```
public static ThreadsInfo readFromPool(java.io.DataInputStream in)
                                throws java.io.IOException
```
    Obtains an instance from the object pool and reads the related data from a data input stream (convenience method).
    
    Parameters:
    
    in - the input stream
    
    Returns:
    
    the instance read from the stream
    
    Throws:
    
    java.io.IOException - in case that an I/O error occurred while reading
  - setThreadId
```
public void setThreadId(long currentThreadId)
```
    Specifies the thread id to initialize (reusable) instances.
    
    Parameters:
    
    currentThreadId - the current thread id
    
    Since:
    
    1.00
  - setInstanceId
```
public void setInstanceId(long currentInstanceId)
```
    Specifies the instance id to initialize (reusable) instances.
    
    Parameters:
    
    currentInstanceId - the current instance id (0 for disabled)
    
    Since:
    
    1.00
  - setIds
```
public void setIds(long currentThreadId,
                   long currentInstanceId)
```
    Specifies both ids to initialize (reusable) instances.
    
    Parameters:
    
    currentThreadId - the current thread id
    
    currentInstanceId - the current instance id (0 for disabled)
    
    Since:
    
    1.00
  - setCurrentThreadTicks
```
public void setCurrentThreadTicks(long currentThreadTicks)
```
    Specifies the thread time ticks to initialize (reusable) instances.
    
    Parameters:
    
    currentThreadTicks - the current thread time ticks (CPU time)
    
    Since:
    
    1.00
  - clear
```
public void clear()
```
    Clears this instance before returning it to the pool.
    
    Specified by:
    
    clear in interface Poolable<ThreadsInfo>
    
    Since:
    
    1.00
  - write
```
public void write(java.io.DataOutputStream out)
           throws java.io.IOException
```
    Writes this instance to a data output stream.
    
    Parameters:
    
    out - the output stream
    
    Throws:
    
    java.io.IOException - in case that an I/O error occurred while writing
  - read
```
public void read(java.io.DataInputStream in)
          throws java.io.IOException
```
    Reads this instance from a data input stream.
    
    Parameters:
    
    in - the input stream
    
    Throws:
    
    java.io.IOException - in case that an I/O error occurred while reading
  - getCurrentThreadTicks
```
public long getCurrentThreadTicks()
```
    Returns the time ticks consumed by the current thread as given in the constructor. Note, that the result is not the current id of the thread executing this method!
    
    Returns:
    
    the time ticks consumed by the current thread
  - getCurrentThreadId
```
public long getCurrentThreadId()
```
    Returns the current thread id as given in the constructor. Note, that the result is not the current id of the thread executing this method!
    
    Returns:
    
    the threadId the current thread id
  - getCurrentInstanceId
```
public long getCurrentInstanceId()
```
    Returns the current instance id.
    
    Returns:
    
    the instance id (disabled if 0)
  - toString
```
public java.lang.String toString()
```
    Returns a textual representation.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the textual representation

Class ThreadsInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POOL

currentThreadTicks

currentThreadId

currentInstanceId

Constructor Detail

ThreadsInfo

Method Detail

create

readFromPool

setThreadId

setInstanceId

setIds

setCurrentThreadTicks

clear

write

read

getCurrentThreadTicks

getCurrentThreadId

getCurrentInstanceId

toString