PerformanceMetrics (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.PerformanceMetrics

public class PerformanceMetrics
extends Object

Collects various performance metrics.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PerformanceMetric`	`getBotIdle()` Time bot spends idle.
`PerformanceMetric`	`getBotResponse()` Time spent waiting for bot event handlers to complete for a single frame.
`PerformanceMetric`	`getClientIdle()` Time the main thread spends idle, waiting for the bot to finish processing frames.
`PerformanceMetric`	`getCommunicationListenToReceive()` Time spent waiting for a "frame ready" signal from BWAPI.
`PerformanceMetric`	`getCommunicationSendToReceive()` Time spent waiting for a response from BWAPI, inclusive of the time spent sending the signal to BWAPI and the time spent waiting for and receiving it.
`PerformanceMetric`	`getCommunicationSendToSent()` Time spent sending the "frame complete" signal to BWAPI.
`PerformanceMetric`	`getCopyingToBuffer()` Time spent copying game data from system pipe shared memory to a frame buffer.
`PerformanceMetric`	`getExcessSleep()` Time the main thread spends oversleeping its timeout target, potentially causing overtime frames.
`PerformanceMetric`	`getFlushSideEffects()` Time spent applying bot commands to the live frame.
`PerformanceMetric`	`getFrameBufferSize()` Number of frames backed up in the frame buffer, after enqueuing each frame (and not including the newest frame).
`PerformanceMetric`	`getFrameDurationReceiveToReceive()` Duration of a frame cycle originating at the time when JBWAPI observes a new frame in shared memory.
`PerformanceMetric`	`getFrameDurationReceiveToSend()` Duration of the frame cycle steps measured by BWAPI, from receiving a frame to BWAPI to sending commands back exclusive of the time spent sending commands back.
`PerformanceMetric`	`getFrameDurationReceiveToSent()` Duration of the frame cycle steps measured by BWAPI, from receiving a frame to BWAPI to sending commands back inclusive of the time spent sending commands back.
`PerformanceMetric`	`getFramesBehind()` Number of frames behind real-time the bot is at the time it handles events.
`PerformanceMetric`	`getIntentionallyBlocking()` Time spent intentionally blocking on bot operation due to a full frame buffer.
`PerformanceMetric`	`getNumberOfEvents()` The number of events sent by BWAPI each frame.
`PerformanceMetric`	`getNumberOfEventsTimesDurationReceiveToSent()` The number of events sent by BWAPI each frame, multiplied by the duration of time spent on that frame (receive-to-sent).
`void`	`reset()` Clears all tracked data and starts counting from a blank slate.
`String`	`toString()`

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

- Method Detail
  - getFrameDurationReceiveToSend
```
public PerformanceMetric getFrameDurationReceiveToSend()
```
    Duration of the frame cycle steps measured by BWAPI, from receiving a frame to BWAPI to sending commands back *exclusive* of the time spent sending commands back.
  - getFrameDurationReceiveToSent
```
public PerformanceMetric getFrameDurationReceiveToSent()
```
    Duration of the frame cycle steps measured by BWAPI, from receiving a frame to BWAPI to sending commands back *inclusive* of the time spent sending commands back.
  - getFrameDurationReceiveToReceive
```
public PerformanceMetric getFrameDurationReceiveToReceive()
```
    Duration of a frame cycle originating at the time when JBWAPI observes a new frame in shared memory.
  - getCopyingToBuffer
```
public PerformanceMetric getCopyingToBuffer()
```
    Time spent copying game data from system pipe shared memory to a frame buffer. Applicable only in asynchronous mode.
  - getIntentionallyBlocking
```
public PerformanceMetric getIntentionallyBlocking()
```
    Time spent intentionally blocking on bot operation due to a full frame buffer. Applicable only in asynchronous mode.
  - getFrameBufferSize
```
public PerformanceMetric getFrameBufferSize()
```
    Number of frames backed up in the frame buffer, after enqueuing each frame (and not including the newest frame). Applicable only in asynchronous mode.
  - getFramesBehind
```
public PerformanceMetric getFramesBehind()
```
    Number of frames behind real-time the bot is at the time it handles events. Applicable only in asynchronous mode.
  - getFlushSideEffects
```
public PerformanceMetric getFlushSideEffects()
```
    Time spent applying bot commands to the live frame.
  - getBotResponse
```
public PerformanceMetric getBotResponse()
```
    Time spent waiting for bot event handlers to complete for a single frame.
  - getCommunicationSendToReceive
```
public PerformanceMetric getCommunicationSendToReceive()
```
    Time spent waiting for a response from BWAPI, inclusive of the time spent sending the signal to BWAPI and the time spent waiting for and receiving it.
  - getCommunicationSendToSent
```
public PerformanceMetric getCommunicationSendToSent()
```
    Time spent sending the "frame complete" signal to BWAPI. Significant durations would indicate something blocking writes to shared memory.
  - getCommunicationListenToReceive
```
public PerformanceMetric getCommunicationListenToReceive()
```
    Time spent waiting for a "frame ready" signal from BWAPI. This time likely additional response time spent by other bots and StarCraft itself.
  - getBotIdle
```
public PerformanceMetric getBotIdle()
```
    Time bot spends idle. Applicable only in asynchronous mode.
  - getClientIdle
```
public PerformanceMetric getClientIdle()
```
    Time the main thread spends idle, waiting for the bot to finish processing frames. Applicable only in asynchronous mode.
  - getExcessSleep
```
public PerformanceMetric getExcessSleep()
```
    Time the main thread spends oversleeping its timeout target, potentially causing overtime frames. Applicable only in asynchronous mode.
  - getNumberOfEvents
```
public PerformanceMetric getNumberOfEvents()
```
    The number of events sent by BWAPI each frame. Helps detect use of broken BWAPI 4.4 tournament modules, with respect to: - https://github.com/bwapi/bwapi/issues/860 - https://github.com/davechurchill/StarcraftAITournamentManager/issues/42
  - getNumberOfEventsTimesDurationReceiveToSent
```
public PerformanceMetric getNumberOfEventsTimesDurationReceiveToSent()
```
    The number of events sent by BWAPI each frame, multiplied by the duration of time spent on that frame (receive-to-sent). Helps detect use of broken BWAPI 4.4 tournament modules, with respect to: - https://github.com/bwapi/bwapi/issues/860 - https://github.com/davechurchill/StarcraftAITournamentManager/issues/42
  - reset
```
public void reset()
```
    Clears all tracked data and starts counting from a blank slate.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PerformanceMetrics

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFrameDurationReceiveToSend

getFrameDurationReceiveToSent

getFrameDurationReceiveToReceive

getCopyingToBuffer

getIntentionallyBlocking

getFrameBufferSize

getFramesBehind

getFlushSideEffects

getBotResponse

getCommunicationSendToReceive

getCommunicationSendToSent

getCommunicationListenToReceive

getBotIdle

getClientIdle

getExcessSleep

getNumberOfEvents

getNumberOfEventsTimesDurationReceiveToSent

reset

toString