1. module tunnel
   1. function tunnel.debug ()
   2. function tunnel.httpOverHttp (options)
   3. function tunnel.httpOverHttps (options)
   4. function tunnel.httpsOverHttp (options)
   5. function tunnel.httpsOverHttps (options)
   6. object tunnel
2. module tunnel.tunnel
   1. function tunnel.tunnel.debug ()
   2. function tunnel.tunnel.httpOverHttp (options)
   3. function tunnel.tunnel.httpOverHttps (options)
   4. function tunnel.tunnel.httpsOverHttp (options)
   5. function tunnel.tunnel.httpsOverHttps (options)

module tunnel

function tunnel.debug ()

• description and source-code

  debug = function () {}

• example usage

  n/a

function tunnel.httpOverHttp (options)

• description and source-code

  function httpOverHttp(options) {
    var agent = new TunnelingAgent(options);
    agent.request = http.request;
    return agent;
  }

• example usage

  ...
    $ npm install tunnel
  
  ## Usages
  
  ### HTTP over HTTP tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpOverHttp({
  maxSockets: poolSize, // Defaults to 5
  
  proxy: { // Proxy settings
    host: proxyHost, // Defaults to 'localhost'
    port: proxyPort, // Defaults to 80
    localAddress: localAddress, // Local interface if necessary
  ...

function tunnel.httpOverHttps (options)

• description and source-code

  function httpOverHttps(options) {
    var agent = new TunnelingAgent(options);
    agent.request = https.request;
    return agent;
  }

• example usage

  ...
  agent: tunnelingAgent
  });
  ```
  
  ### HTTP over HTTPS tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpOverHttps({
  maxSockets: poolSize, // Defaults to 5
  
  proxy: { // Proxy settings
    host: proxyHost, // Defaults to 'localhost'
    port: proxyPort, // Defaults to 443
    localAddress: localAddress, // Local interface if necessary
  ...

function tunnel.httpsOverHttp (options)

• description and source-code

  function httpsOverHttp(options) {
    var agent = new TunnelingAgent(options);
    agent.request = http.request;
    agent.createSocket = createSecureSocket;
    return agent;
  }

• example usage

  ...
  # node-tunnel - HTTP/HTTPS Agents for tunneling proxies
  
  ## Example
  
  ```javascript
  var tunnel = require('tunnel');
  
  var tunnelingAgent = tunnel.httpsOverHttp({
    proxy: {
      host: 'localhost',
      port: 3128
    }
  });
  
  var req = https.request({
  ...

function tunnel.httpsOverHttps (options)

• description and source-code

  function httpsOverHttps(options) {
    var agent = new TunnelingAgent(options);
    agent.request = https.request;
    agent.createSocket = createSecureSocket;
    return agent;
  }

• example usage

  ...
  agent: tunnelingAgent
  });
  ```
  
  ### HTTPS over HTTPS tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpsOverHttps({
  maxSockets: poolSize, // Defaults to 5
  
  // CA for origin server if necessary
  ca: [ fs.readFileSync('origin-server-ca.pem')],
  
  // Client certification for origin server if necessary
  key: fs.readFileSync('origin-server-key.pem'),
  ...

module tunnel.tunnel

function tunnel.tunnel.debug ()

• description and source-code

  debug = function () {}

• example usage

  n/a

function tunnel.tunnel.httpOverHttp (options)

• description and source-code

  function httpOverHttp(options) {
    var agent = new TunnelingAgent(options);
    agent.request = http.request;
    return agent;
  }

• example usage

  ...
    $ npm install tunnel
  
  ## Usages
  
  ### HTTP over HTTP tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpOverHttp({
  maxSockets: poolSize, // Defaults to 5
  
  proxy: { // Proxy settings
    host: proxyHost, // Defaults to 'localhost'
    port: proxyPort, // Defaults to 80
    localAddress: localAddress, // Local interface if necessary
  ...

function tunnel.tunnel.httpOverHttps (options)

• description and source-code

  function httpOverHttps(options) {
    var agent = new TunnelingAgent(options);
    agent.request = https.request;
    return agent;
  }

• example usage

  ...
  agent: tunnelingAgent
  });
  ```
  
  ### HTTP over HTTPS tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpOverHttps({
  maxSockets: poolSize, // Defaults to 5
  
  proxy: { // Proxy settings
    host: proxyHost, // Defaults to 'localhost'
    port: proxyPort, // Defaults to 443
    localAddress: localAddress, // Local interface if necessary
  ...

function tunnel.tunnel.httpsOverHttp (options)

• description and source-code

  function httpsOverHttp(options) {
    var agent = new TunnelingAgent(options);
    agent.request = http.request;
    agent.createSocket = createSecureSocket;
    return agent;
  }

• example usage

  ...
  # node-tunnel - HTTP/HTTPS Agents for tunneling proxies
  
  ## Example
  
  ```javascript
  var tunnel = require('tunnel');
  
  var tunnelingAgent = tunnel.httpsOverHttp({
    proxy: {
      host: 'localhost',
      port: 3128
    }
  });
  
  var req = https.request({
  ...

function tunnel.tunnel.httpsOverHttps (options)

• description and source-code

  function httpsOverHttps(options) {
    var agent = new TunnelingAgent(options);
    agent.request = https.request;
    agent.createSocket = createSecureSocket;
    return agent;
  }

• example usage

  ...
  agent: tunnelingAgent
  });
  ```
  
  ### HTTPS over HTTPS tunneling
  
  ```javascript
  var tunnelingAgent = tunnel.httpsOverHttps({
  maxSockets: poolSize, // Defaults to 5
  
  // CA for origin server if necessary
  ca: [ fs.readFileSync('origin-server-ca.pem')],
  
  // Client certification for origin server if necessary
  key: fs.readFileSync('origin-server-key.pem'),
  ...