Interface IPings

Namespace

PushTechnology.ClientInterface.Client.Features

Assembly

Diffusion.Client.dll

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

public interface IPings : IFeature

Inherited Members

IFeature.Session

Remarks

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 an ISession as follows:

var ping = session.Ping;

// Pinging the server and waiting for the result.
// This operation will block until the ping details have
// been received.
var details = pings.PingServerAsync().Result;

// Any exceptions thrown within the PingServerAsync()
// method will be packed into an AggregateException.
try {
    var details = pings.PingServerAsync().Result;
} catch ( AggregateException ae ) {
    ae.Handle( ex => {
        // Handle specific exception in here.
        return true; // Exception is handled.
    } );
}

// Pinging the server in an async/await scenario.
var details = await pings.PingServerAsync();

// Exceptions in an async/await scenario will not
// be bundled into an AggregateException so they
// have to be handled in the usual way.
try {
    var details = await pings.PingServerAsync();
} catch ( SessionClosedException ex ) {
    // Handle session closed exception.
}

// The await/async pattern is the preferred way to
// use the IPings feature. For more information visit:
// https://msdn.microsoft.com/en-gb/library/mt674882.aspx

Added in version 5.0.

Methods

PingServerAsync()

Sends a ping request to the server.

Task<IPingDetails> PingServerAsync()

Returns

Task<IPingDetails>

The task representing the current operation.

Remarks

Since 6.0

Exceptions

SessionClosedException

The session is closed. Thrown by the returned task.

See Also

PingServerAsync(CancellationToken)

PingServerAsync(CancellationToken)

Sends a ping request to the server.

Task<IPingDetails> PingServerAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token used to cancel the current operation.

Returns

Task<IPingDetails>

The task representing the current operation.

Examples

Pinging the server with a cancellation token

try {
    var src = new CancellationTokenSource();
    var details = await session.Ping.PingServerAsync( src.Token );
} catch ( SessionClosedException ex ) {
    Console.WriteLine( $"Ping failed. Reason: {ex}." );
}

Remarks

Since 6.0

Exceptions

SessionClosedException

The session is closed. Thrown by the returned task.