\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28197}{}\doxysubsection{Turn a function into an $<$a href=\char`\"{}https\+://nodejs.\+org/api/http.\+html\#http\+\_\+class\+\_\+http\+\_\+agent\char`\"{}$>$$<$tt$>$http.\+Agent$<$/tt$>$$<$/a$>$ instance}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28197}
\href{https://travis-ci.org/TooTallNate/node-agent-base}{\texttt{ }}

This module provides an {\ttfamily http.\+Agent} generator. That is, you pass it an async callback function, and it returns a new {\ttfamily http.\+Agent} instance that will invoke the given callback function when sending outbound HTTP requests.\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28198}{}\doxysubsubsection{Some subclasses\+:}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28198}
Here\textquotesingle{}s some more interesting uses of {\ttfamily agent-\/base}. Send a pull request to list yours!


\begin{DoxyItemize}
\item \href{https://github.com/TooTallNate/node-http-proxy-agent}{\texttt{ {\ttfamily http-\/proxy-\/agent}}}\+: An HTTP(s) proxy {\ttfamily http.\+Agent} implementation for HTTP endpoints
\item \href{https://github.com/TooTallNate/node-https-proxy-agent}{\texttt{ {\ttfamily https-\/proxy-\/agent}}}\+: An HTTP(s) proxy {\ttfamily http.\+Agent} implementation for HTTPS endpoints
\item \href{https://github.com/TooTallNate/node-pac-proxy-agent}{\texttt{ {\ttfamily pac-\/proxy-\/agent}}}\+: A PAC file proxy {\ttfamily http.\+Agent} implementation for HTTP and HTTPS
\item \href{https://github.com/TooTallNate/node-socks-proxy-agent}{\texttt{ {\ttfamily socks-\/proxy-\/agent}}}\+: A SOCKS (v4a) proxy {\ttfamily http.\+Agent} implementation for HTTP and HTTPS
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28199}{}\doxysection{Installation}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28199}
Install with {\ttfamily npm}\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{\$ npm install agent-\/base }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28200}{}\doxysection{Example}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28200}
Here\textquotesingle{}s a minimal example that creates a new {\ttfamily net.\+Socket} connection to the server for every HTTP request (i.\+e. the equivalent of {\ttfamily agent\+: false} option)\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{var net = require('net');}
\DoxyCodeLine{var tls = require('tls');}
\DoxyCodeLine{var url = require('url');}
\DoxyCodeLine{var http = require('http');}
\DoxyCodeLine{var agent = require('agent-\/base');}
\DoxyCodeLine{}
\DoxyCodeLine{var endpoint = 'http://nodejs.org/api/';}
\DoxyCodeLine{var parsed = url.parse(endpoint);}
\DoxyCodeLine{}
\DoxyCodeLine{// This is the important part!}
\DoxyCodeLine{parsed.agent = agent(function (req, opts) \{}
\DoxyCodeLine{  var socket;}
\DoxyCodeLine{  // `secureEndpoint` is true when using the https module}
\DoxyCodeLine{  if (opts.secureEndpoint) \{}
\DoxyCodeLine{    socket = tls.connect(opts);}
\DoxyCodeLine{  \} else \{}
\DoxyCodeLine{    socket = net.connect(opts);}
\DoxyCodeLine{  \}}
\DoxyCodeLine{  return socket;}
\DoxyCodeLine{\});}
\DoxyCodeLine{}
\DoxyCodeLine{// Everything else works just like normal...}
\DoxyCodeLine{http.get(parsed, function (res) \{}
\DoxyCodeLine{  console.log('"{}response"{} event!', res.headers);}
\DoxyCodeLine{  res.pipe(process.stdout);}
\DoxyCodeLine{\}); }

\end{DoxyCode}


Returning a Promise or using an {\ttfamily async} function is also supported\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{agent(async function (req, opts) \{}
\DoxyCodeLine{  await sleep(1000);}
\DoxyCodeLine{  // etc…}
\DoxyCodeLine{\}); }

\end{DoxyCode}


Return another {\ttfamily http.\+Agent} instance to \char`\"{}pass through\char`\"{} the responsibility for that HTTP request to that agent\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{agent(function (req, opts) \{}
\DoxyCodeLine{  return opts.secureEndpoint ? https.globalAgent : http.globalAgent;}
\DoxyCodeLine{\}); }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28201}{}\doxysection{API}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28201}
\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28202}{}\doxysection{Agent(\+Function callback\mbox{[}, Object options\mbox{]}) → $<$a href=\char`\"{}https\+://nodejs.\+org/api/http.\+html\#http\+\_\+class\+\_\+http\+\_\+agent\char`\"{}$>$http.\+Agent$<$/a$>$}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28202}
Creates a base {\ttfamily http.\+Agent} that will execute the callback function {\ttfamily callback} for every HTTP request that it is used as the {\ttfamily agent} for. The callback function is responsible for creating a {\ttfamily stream.\+Duplex} instance of some kind that will be used as the underlying socket in the HTTP request.

The {\ttfamily options} object accepts the following properties\+:


\begin{DoxyItemize}
\item {\ttfamily timeout} -\/ Number -\/ Timeout for the {\ttfamily callback()} function in milliseconds. Defaults to Infinity (optional).
\end{DoxyItemize}

The callback function should have the following signature\+:\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28203}{}\doxysubsection{callback(http.\+Client\+Request req, Object options, Function cb) → undefined}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28203}
The Client\+Request {\ttfamily req} can be accessed to read request headers and and the path, etc. The {\ttfamily options} object contains the options passed to the {\ttfamily http.\+request()}/{\ttfamily https.\+request()} function call, and is formatted to be directly passed to {\ttfamily net.\+connect()}/{\ttfamily tls.\+connect()}, or however else you want a Socket to be created. Pass the created socket to the callback function {\ttfamily cb} once created, and the HTTP request will continue to proceed.

If the {\ttfamily https} module is used to invoke the HTTP request, then the {\ttfamily secure\+Endpoint} property on {\ttfamily options} {\itshape will be set to {\ttfamily true}}.\hypertarget{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28204}{}\doxysection{License}\label{md_sfcode_node_modules_socks_proxy_agent_node_modules_agent_base_README_autotoc_md28204}
(The MIT License)

Copyright (c) 2013 Nathan Rajlich $<$\href{mailto:nathan@tootallnate.net}{\texttt{ nathan@tootallnate.\+net}}$>$

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \textquotesingle{}Software\textquotesingle{}), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions\+:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED \textquotesingle{}AS IS\textquotesingle{}, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 