File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPProxyServer.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPProxyServer - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">HTTPServer
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPProxyServer">
<h1 id="class-WEBrick::HTTPProxyServer" class="class">
class WEBrick::HTTPProxyServer
</h1>
<section class="description">
<p>An HTTP Proxy server which proxies GET, HEAD and POST requests.</p>
<p>To create a simple proxy server:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'webrick'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'webrick/httpproxy'</span>
<span class="ruby-identifier">proxy</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPProxyServer</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">Port:</span> <span class="ruby-value">8000</span>
<span class="ruby-identifier">trap</span> <span class="ruby-string">'INT'</span> <span class="ruby-keyword">do</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">shutdown</span> <span class="ruby-keyword">end</span>
<span class="ruby-identifier">trap</span> <span class="ruby-string">'TERM'</span> <span class="ruby-keyword">do</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">shutdown</span> <span class="ruby-keyword">end</span>
<span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">start</span>
</pre>
<p>See <a href="HTTPProxyServer.html#method-c-new"><code>::new</code></a> for proxy-specific configuration items.</p>
<h2 id="class-WEBrick::HTTPProxyServer-label-Modifying+proxied+responses">Modifying proxied responses<span><a href="#class-WEBrick::HTTPProxyServer-label-Modifying+proxied+responses">¶</a> <a href="#top">↑</a></span></h2>
<p>To modify content the proxy server returns use the <code>:ProxyContentHandler</code> option:</p>
<pre class="ruby"><span class="ruby-identifier">handler</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">res</span>[<span class="ruby-string">'content-type'</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'text/plain'</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\nThis content was proxied!\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">proxy</span> =
<span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPProxyServer</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">Port:</span> <span class="ruby-value">8000</span>, <span class="ruby-value">ProxyContentHandler:</span> <span class="ruby-identifier">handler</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(config={}, default=Config::HTTP)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Proxy server configurations. The proxy server handles the following configuration items in addition to those supported by HTTPServer:</p>
<dl class="rdoc-list note-list"><dt>:ProxyAuthProc
<dd>
<p>Called with a request and response to authorize a request</p>
</dd><dt>:ProxyVia
<dd>
<p>Appended to the via header</p>
</dd><dt>:ProxyURI
<dd>
<p>The proxy server's <a href="../URI.html"><code>URI</code></a></p>
</dd><dt>:ProxyContentHandler
<dd>
<p>Called with a request and response and allows modification of the response</p>
</dd><dt>:ProxyTimeout
<dd>
<p>Sets the proxy timeouts to 30 seconds for open and 60 seconds for read operations</p>
</dd></dl>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpproxy.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">config</span>={}, <span class="ruby-identifier">default</span>=<span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">default</span>)
<span class="ruby-identifier">c</span> = <span class="ruby-ivar">@config</span>
<span class="ruby-ivar">@via</span> = <span class="ruby-node">"#{c[:HTTPVersion]} #{c[:ServerName]}:#{c[:Port]}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>