Giter VIP home page Giter VIP logo

electrode-keepalive's Introduction

electrode-keepalive

electrode-keepalive provides an HttpAgent capable of maintaining available sockets using IP address instead of hostname lookup. This allows for graceful handling of dns changes/failover when changes occur in routing configuration. This is particularly important when using keep-alive enabled connections. It resolves part of the problems in this issue

Usage

const ElectrodeKeepAlive = require("electrode-keepalive");

const opts = {
  keepAlive: true,
  keepAliveMsecs: 30000, // socket send keep alive ping every 30 secs
  maxSockets: 100,
  maxFreeSockets: 10
};

const keepAlive = new ElectrodeKeepAlive(opts);

const dnsOptions = {};

keepAlive.preLookup("www.google.com", dnsOptions, (err) => {
  request({url: "http://www.google.com", agent: keepAlive.agent});
});

Since this module works by overriding http.Agent's synchronous getName method to return the IP instead of hostname, it has to use a pre-populated DNS mapping. Before the mapping is populated, it can't use IP. To avoid that in your first request, you should always call the preLookup method first.

APIs

Properties

instance.agent - Read only instance property to access the http/https agent.

instance.https - Read only instance property. If true, then the agent is an https agent.

ElectrodeKeepAlive.DNS_CACHE - Internal DNS mapping object.

Methods

constructor(options)

Creates an instance of ElectrodeKeepAlive.

  • options should be the default http agent settings that are passed through to the underlying implementation. Additionally the following options are supported:

    • https - If true, then creates an https Agent.
    • expiry - The duration (in milliseconds) that ip entries in the DNS mapping will be refreshed. Default is 5000ms.

instance.preLookup(host, options, callback)

Allows ElectrodeKeepAlive to do a DNS lookup on the host first to populate its DNS mapping.

The arguments matches Node dns module lookup.

instance.clearDnsCache() - Wipes out current DNS mapping.

instance.getName(options)

The internal method to override http agent's default getName. Not intended for public use.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.