PerfCakeDebug (PerfCake API Documentation (version 7.5))

java.lang.Object
- org.perfcake.debug.PerfCakeDebug

```
public class PerfCakeDebug
extends Object
```
JMX based debug agent providing information about the running performance test.

Author:

Martin Večeřa

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PerfCakeDebug`	`getInstance()` Gets the agent instance.
`static void`	`initialize()` Initializes the debug agent.
`static void`	`reportCorrelatedMessage()` Reports a received message.
`static void`	`reportCorrelatorName(Correlator correlator)` Reports the correlator class name.
`static void`	`reportGeneratorName(MessageGenerator generator)` Reports the message generator class name.
`static void`	`reportNewSenderTask()` Reports a new instance of a sender task was created.
`static void`	`reportParentReporter(Destination destination, Reporter reporter)` Reports the destination's parent reporter for later matching.
`static void`	`reportReceiverName(Receiver receiver)` Reports the receiver class name.
`static void`	`reportReporterUsage(Reporter reporter)` Reports a measurement unit was sent to report for accumulation.
`static void`	`reportResultWritten(Destination destination)` Reports a result written to a destination.
`static void`	`reportSenderName(String senderClassName)` Reports the sender class name.
`static void`	`reportSentMessage()` Reports sending of a message.
`static void`	`reportSequenceName(String sequenceId, Sequence sequence)` Reports the sequence class name.
`static void`	`reportSequenceSnapshot()` Reports a sequences snapshot has been taken.
`static void`	`reportValidationResult(MessageValidator validator, boolean valid)` Reports a validation result.
`static void`	`reportValidatorName(String validatorId, MessageValidator validator)` Reports validator class name.

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

- Method Detail
  - getInstance
```
public static PerfCakeDebug getInstance()
```
    Gets the agent instance.
    
    Returns:
    
    The agent instance. Can be null when the agent was not initialized.
  - initialize
```
public static void initialize()
```
    Initializes the debug agent.
  - reportGeneratorName
```
public static void reportGeneratorName(MessageGenerator generator)
```
    Reports the message generator class name.
    
    Parameters:
    
    generator - The message generator instance.
  - reportSenderName
```
public static void reportSenderName(String senderClassName)
```
    Reports the sender class name.
    
    Parameters:
    
    senderClassName - The sender class name.
  - reportReceiverName
```
public static void reportReceiverName(Receiver receiver)
```
    Reports the receiver class name.
    
    Parameters:
    
    receiver - The receiver instance.
  - reportCorrelatorName
```
public static void reportCorrelatorName(Correlator correlator)
```
    Reports the correlator class name.
    
    Parameters:
    
    correlator - The correlator instance.
  - reportSequenceName
```
public static void reportSequenceName(String sequenceId,
                                      Sequence sequence)
```
    Reports the sequence class name.
    
    Parameters:
    
    sequenceId - The sequence id.
    
    sequence - The sequence instance.
  - reportValidatorName
```
public static void reportValidatorName(String validatorId,
                                       MessageValidator validator)
```
    Reports validator class name.
    
    Parameters:
    
    validatorId - The validator id.
    
    validator - The validator instance.
  - reportNewSenderTask
```
public static void reportNewSenderTask()
```
    Reports a new instance of a sender task was created.
  - reportSentMessage
```
public static void reportSentMessage()
```
    Reports sending of a message.
  - reportCorrelatedMessage
```
public static void reportCorrelatedMessage()
```
    Reports a received message.
  - reportSequenceSnapshot
```
public static void reportSequenceSnapshot()
```
    Reports a sequences snapshot has been taken.
  - reportReporterUsage
```
public static void reportReporterUsage(Reporter reporter)
```
    Reports a measurement unit was sent to report for accumulation.
    
    Parameters:
    
    reporter - The reporter instance.
  - reportParentReporter
```
public static void reportParentReporter(Destination destination,
                                        Reporter reporter)
```
    Reports the destination's parent reporter for later matching.
    
    Parameters:
    
    destination - The destination instance.
    
    reporter - The reporter instance.
  - reportResultWritten
```
public static void reportResultWritten(Destination destination)
```
    Reports a result written to a destination.
    
    Parameters:
    
    destination - The destination instance.
  - reportValidationResult
```
public static void reportValidationResult(MessageValidator validator,
                                          boolean valid)
```
    Reports a validation result.
    
    Parameters:
    
    validator - The validator instance.
    
    valid - The result of the validation.

Class PerfCakeDebug

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

initialize

reportGeneratorName

reportSenderName

reportReceiverName

reportCorrelatorName

reportSequenceName

reportValidatorName

reportNewSenderTask

reportSentMessage

reportCorrelatedMessage

reportSequenceSnapshot

reportReporterUsage

reportParentReporter

reportResultWritten

reportValidationResult