https://github.com/apaszke/tcp-ping

TCP ping utility for node.js
https://github.com/apaszke/tcp-ping

Last synced: about 2 months ago
JSON representation

TCP ping utility for node.js

• Host: GitHub
• URL: https://github.com/apaszke/tcp-ping
• Owner: apaszke
• License: mit
• Created: 2014-04-23T19:55:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-12-04T07:50:03.000Z (10 months ago)
• Last Synced: 2024-07-23T06:47:51.169Z (2 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 123
• Watchers: 3
• Forks: 27
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - apaszke/tcp-ping - TCP ping utility for node.js (JavaScript)

README

        
tcp-ping

========

TCP ping utility for node.js. You can test if chosen address accepts connections at desired port and find out your latency. Great for service availability testing.

##### Why not `ping` wrapper?

* It's much faster than `ping` tool (as soon as connection gets accepted, it's dropped and a new measure is conducted immediately), so there's no unnecessary waiting between requests.

* It allows you to test a specific service, not the whole connection

* Some servers drop ICMP echo without any response, even when online. TCP can work in such cases.

### Install

```

npm install tcp-ping

```

### Functions

##### ping(options, callback)

`options` is an object, which may contain several properties:

* address (address to ping; defaults to `localhost`)

* port (defaults to `80`)

* timeout (in ms; defaults to 5s)

* attempts (how many times to measure time; defaults to 10)

`callback` should be a function with arguments in node convention - `function(err, data)`.

Returned data is an object which looks like this:

```javascript

{

  address: '46.28.246.123',

  port: 80,

  attempts: 10,

  avg: 19.7848844,

  max: 35.306233,

  min: 16.526067,

  results:

   [

    { seq: 0, time: 35.306233 },

    { seq: 1, time: 16.585919 },

    ...

    { seq: 9, time: 17.625968 }

   ]

}

```

##### probe(address, port, callback)

`callback` is a node style callback `function(err, data)`, where data is true if the server is available and false otherwise.

### Usage

```javascript

var tcpp = require('tcp-ping');

tcpp.probe('46.28.246.123', 80, function(err, available) {

    console.log(available);

});

tcpp.ping({ address: '46.28.246.123' }, function(err, data) {

    console.log(data);

});

```