Diffusion Apple API  6.2.0
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Instance Methods | List of all members
PTDiffusionPingsFeature Class Reference

Introduction

The Pings feature provides a client session with the ability to ping 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. Each ping request will return details on the latency experienced in the form of a round-trip time value.

The Pings feature for a session can be obtained from the session's pings property.

See Also
PTDiffusionSession
Since
5.7
Inheritance diagram for PTDiffusionPingsFeature:
PTDiffusionFeature

Instance Methods

(void) - pingServerWithCompletionHandler:
 
- Instance Methods inherited from PTDiffusionFeature
(instancetype) - NS_UNAVAILABLE
 

Additional Inherited Members

- Class Methods inherited from PTDiffusionFeature
(instancetype) + NS_UNAVAILABLE
 
- Properties inherited from PTDiffusionFeature
PTDiffusionSessionsession
 

Method Documentation

- (void) pingServerWithCompletionHandler: (PTDiffusionPingDetails *_Nullable)  details
(NSError *_Nullable error)  completionHandler 

Send a ping to the server.

Parameters
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionRaised if the completionHandler is nil.
Since
5.7