hydroping Namespace Reference

Wraps up liboping (http://verplant.org/liboping/). More...

Classes
class	PingException
class	Pinger
Functions
double	pingLatencyMs (const std::string &host, bool runWithSudo, const std::string &pathToHydroPing)

---

Detailed Description

Wraps up liboping (http://verplant.org/liboping/).

See also:

libHydroPing

---

Function Documentation

double hydroping::pingLatencyMs	(	const std::string &	host,
		bool	runWithSudo,
		const std::string &	pathToHydroPing
	)

Runs the 'hydroping' stand-alone executable (via the OS), returns the result. Note that 'hydroping' needs to be run with root permissions, if you don't have them setting 'runWithSudo' will prefix the command with 'sudo <cmd>'

pathToHydroPing specifies the full path to the 'hydroping' binary, e.g. /usr/local/bin/hydroping

Returns:

• >=0 : a latency in milliseconds
• <0 : ping timed out.

Throws PingException if 'hydroping' ran, e.g. when DNS lookup of the host failed. Throws gbxutilacfr::Exception if the system was unable to run 'hydroping', e.g. the specified path to the binary was invalid or the permissions were insufficient.