org.eclipse.paho.client.mqttv3.util

Class Debug

java.lang.Object

org.eclipse.paho.client.mqttv3.util.Debug

public class Debug
extends java.lang.Object

Utility to help debug problems with the Paho MQTT client Once initialised a call to dumpClientDebug will force any memory trace together with pertinent client and system state to the main log facility. No client wide lock is taken when the dump is progress. This means the set of client state may not be consistent as the client can still be processing work while the dump is in progress.

Constructor Summary

Constructors

Constructor and Description
Debug(java.lang.String clientID, ClientComms comms) Set the debug facility up for a specific client

Method Summary

Modifier and Type	Method and Description
void	dumpBaseDebug() Dump of JVM wide debug info.
void	dumpClientComms() Dump interesting variables from ClientComms
void	dumpClientDebug() Dump maximum debug info.
void	dumpClientState() Dump interesting variables from ClientState
void	dumpConOptions() Dump Connection options
static java.lang.String	dumpProperties(java.util.Properties props, java.lang.String name) Return a set of properties as a formatted string
void	dumpSystemProperties() Dump the current set of system.properties to a log record
static java.lang.String	left(java.lang.String s, int width, char fillChar) Left justify a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Debug

public Debug(java.lang.String clientID,
             ClientComms comms)

Set the debug facility up for a specific client

Parameters:

clientID - the ID of the client being debugged

comms - the ClientComms object of the client being debugged

Method Detail

dumpClientDebug

public void dumpClientDebug()

Dump maximum debug info. This includes state specific to a client as well as debug that is JVM wide like trace and system properties. All state is written as debug log entries.

dumpBaseDebug

public void dumpBaseDebug()

Dump of JVM wide debug info. This includes trace and system properties. Includes trace and system properties

dumpSystemProperties

public void dumpSystemProperties()

Dump the current set of system.properties to a log record

dumpClientState

public void dumpClientState()

Dump interesting variables from ClientState

dumpClientComms

public void dumpClientComms()

Dump interesting variables from ClientComms

dumpConOptions

public void dumpConOptions()

Dump Connection options

dumpProperties

public static java.lang.String dumpProperties(java.util.Properties props,
                                              java.lang.String name)

Return a set of properties as a formatted string

left

public static java.lang.String left(java.lang.String s,
                                    int width,
                                    char fillChar)

Left justify a string.

Parameters:

s - the string to justify

width - the field width to justify within

fillChar - the character to fill with

Returns:

the justified string.