com.pushtechnology.diffusion.client.features

Interface Pings

All Superinterfaces:

Feature

public interface Pings
extends Feature

This feature provides a client session with the ability to test its connection to the server.

The main purpose of a ping is to test, at a very basic level, the current network conditions that exist between the client session and the server it is connected to. The ping response includes the time taken to make a round-trip call to the server.

Access control

There are no permissions requirements associated with this feature.

Accessing the feature

This feature may be obtained from a session, and used as follows:

 Pings pings = session.feature(Pings.class);

 CompletableFuture<PingDetails> response = pings.pingServer();

 PingDetails result = response.get();  // Block for response

 System.out.printf("Round-trip call to server took %d milliseconds%n", result.getRoundTripTime());
 

Alternatively, the CompletableFuture API can be used to process the result using the Diffusion input thread, without blocking the calling thread:

 Pings pings = session.feature(Pings.class);

 pings.pingServer()
      .thenApply(PingDetails::getRoundTripTime)
      .thenAccept(t -> System.out.printf("Round-trip call to server took %d milliseconds%n", t));
 

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Pings.PingCallback Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
static interface	Pings.PingContextCallback<C> Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
static interface	Pings.PingDetails Server response to a ping.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Pings.PingDetails>	pingServer() Send a ping request to the server.
<C> void	pingServer(C context, Pings.PingContextCallback<C> callback) Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.
void	pingServer(Pings.PingCallback callback) Deprecated. since 6.7 Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Methods inherited from interface com.pushtechnology.diffusion.client.session.Feature

getSession

Method Detail

pingServer

CompletableFuture<Pings.PingDetails> pingServer()

Send a ping request to the server.

Returns:

a CompletableFuture that completes when a response is received from the server

If the ping was successful, the CompletableFuture will complete successfully. The result is a Pings.PingDetails containing timing information.

Otherwise, the CompletableFuture will complete exceptionally with a CompletionException. Common reasons for failure, listed by the exception reported as the cause, include:

• SessionClosedException – if the session is closed.

Since:

6.0

pingServer

@Deprecated
void pingServer(Pings.PingCallback callback)

Deprecated. since 6.7

Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Sends a ping request to the server.

The callback's onPingResponse method will be called with the response.

Parameters:

callback - the callback for the response to this ping operation

pingServer

@Deprecated
<C> void pingServer(C context,
                                Pings.PingContextCallback<C> callback)

Deprecated. since 6.7

Methods that use callbacks are deprecated and will be removed in a future release. Use CompletableFuture variant instead.

Sends a ping request to the server.

The callback's onPingResponse method will be called with the response.

Type Parameters:

C - context object type

Parameters:

context - the context object that will be passed to the callback

callback - the callback for the response to this ping operation