Newlyweds Proposing Marriage

    This package has been deprecated

    Author message:

    this package has been deprecated; use cordova-plugin-ping instead

    cordova-plugin-ping-pong

    0.5.0 • Public • Published

    cordova-plugin-ping-pong

    NPM version

    This plugin implements the ping software utility.

    cordova-plugin-ping-pong is a fork of t1st3's cordova-plugin-ping which adds iOS support written by Hughes Systique.

    Supported Platforms

    • Android
    • iOS

    Installation

    cordova plugin add cordova-plugin-ping-pong

    or

    cordova plugin add https://github.com/joeytwiddle/cordova-plugin-ping-pong.git

    Usage

    This plugin defines a global Ping object. Although the object is in the global scope, it is not available until after the deviceready event.

    Ping a domain

    • query : Domain or IP address to ping.
    • timeout : Time to wait for a response, in seconds.
    • retry : Number of echo requests to send.
    • version : Ping IPv4 or IPv6 address (Ping or Ping6).
    document.addEventListener('deviceready', onDeviceReady, false);
    function onDeviceReady() {
      var p, success, err, ipList;
      ipList = [{query: 'www.tiste.org', timeout: 1,retry: 3,version:'v4'},
                {query: 'www.somesite.com', timeout: 2,'retry': 3,version:'v6'}];
      success = function (results) {
        console.log(results);
      };
      err = function (e) {
        console.log('Error: ' + e);
      };
      p = new Ping();
      p.ping(ipList, success, err);
    }

    API

    Ping.ping

    This method takes the following arguments:

    • ipList: an array of json objects with parameters : domain to query, retry, timeout and version.
    • success: a callback function that handles success
    • err: a callback function that handles error

    The callback function for success takes one argument, which is a JSON array of results:

    [{
        "response": {
            "status": "success",
            "result": {
                "target": "www.tiste.org",
                "avgRtt": "4.476",
                "maxRtt": "6.348",
                "minRtt": "1.007",
                "pctTransmitted": "3",
                "pctReceived": "3",
                "pctLoss": "0%"
            }
        },
        "request": {
            "query": "www.tiste.org",
            "timeout": "1",
            "retry": "3",
            "version": "v4"
        }
     }, {
        "response": {
            "status": "success",
            "result": {
                "target": "www.somesite.com",
                "avgRtt": "4.811",
                "maxRtt": "7.294",
                "minRtt": "0.915",
                "pctTransmitted": "3",
                "pctReceived": "3",
                "pctLoss": "0%"
            }
        },
        "request": {
            "query": "www.somesite.com",
            "timeout": "2",
            "retry": "3",
            "version": "v6"
        }
     }]

    The callback function for error takes one argument, which is the error emitted.

    License

    This project is licensed under the MIT license. Check the license file.

    Install

    npm i cordova-plugin-ping-pong

    DownloadsWeekly Downloads

    4

    Version

    0.5.0

    License

    MIT

    Unpacked Size

    78.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • joeytwiddle