PushTechnology.ClientInterface.Client.Features.IPings Interface Reference

A service that provides a client session with the ability to ping the server. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.IPings:

Public Member Functions
void	PingServer (IPingCallback callback)
	Sends a ping request to the server. More...
void	PingServer< TC > (TC context, IPingContextCallback< TC > callback)
	Sends a ping request to the server with a context object. More...

Additional Inherited Members
Properties inherited from PushTechnology.ClientInterface.Client.Features.IFeature
ISession	Session [get]
	Get the session that the service is associated with. More...

Detailed Description

A service that 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.

Access Control

There are no permissions requirements associated with this feature.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.IPings.PingServer

(

IPingCallback

callback

)

Sends a ping request to the server.

Parameters

callback

The callback for the response to this ping operation.

Returns

void PushTechnology.ClientInterface.Client.Features.IPings.PingServer< TC >	(	TC	context,
		IPingContextCallback< TC >	callback
	)

Sends a ping request to the server with a context object.

Parameters

context	The context object that will be passed to the callback.
callback	The callback for the response to this ping operation.

---

The documentation for this interface was generated from the following file:

• UCIStack/Client/Features/IPings.cs