com.goldencode.p2j.net

Class Echo

java.lang.Object

com.goldencode.p2j.net.Echo

public class Echo
extends java.lang.Object

Helper class which provides a simple mechanism to test a session's connectivity.

Author:

GES

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Echo.Invoker Helper class to delegate execution of the transactEcho method.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger (safe as a JVM-wide value rather than as context-local).
private static boolean	tracing Tracing flag (enabled at logging level FINEST).

Constructor Summary

Constructors

Constructor and Description
Echo()

Method Summary

Modifier and Type	Method and Description
static long	ping(java.io.Serializable payload) Test a do-nothing round trip to the other side of this session and back with the given data as a payload.
static long	ping(java.io.Serializable payload, int timeout) Test a do-nothing round trip to the other side of this session and back with the given data as a payload.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger (safe as a JVM-wide value rather than as context-local).

tracing

private static final boolean tracing

Tracing flag (enabled at logging level FINEST).

Constructor Detail

Echo

public Echo()

Method Detail

ping

public static long ping(java.io.Serializable payload)

Test a do-nothing round trip to the other side of this session and back with the given data as a payload. If logging is enabled at the FINEST level, then details of the payload and the elapsed time will be logged.

The protocol's built-in support for ECHO and ECHO_REPLY messages is used to implement this feature. No special server registration is needed on the other side as long as there is a valid session open.

Parameters:

payload - The data to send (and which will be sent back unchanged). It may be null (which represents an empty payload).

Returns:

Round trip time in milliseconds or -1 if a failure occurred.

ping

public static long ping(java.io.Serializable payload,
                        int timeout)

Test a do-nothing round trip to the other side of this session and back with the given data as a payload. If logging is enabled at the FINEST level, then details of the payload and the elapsed time will be logged.

The protocol's built-in support for ECHO and ECHO_REPLY messages is used to implement this feature. No special server registration is needed on the other side as long as there is a valid session open.

Parameters:

payload - The data to send (and which will be sent back unchanged). It may be null (which represents an empty payload).

timeout - Maximum number of milliseconds to wait for a response. Use 0 for an indefinite wait.

Returns:

Round trip time in milliseconds or -1 if a failure occurred.