mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-06 01:15:11 -04:00
8 lines
6.1 KiB
HTML
8 lines
6.1 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Forward (cohttp.Cohttp.Proxy.Forward)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> » <a href="../../../index.html">cohttp</a> » <a href="../../index.html">Cohttp</a> » <a href="../index.html">Proxy</a> » Forward</nav><header class="odoc-preamble"><h1>Module <code><span>Proxy.Forward</span></code></h1><p>Utilities for configuring and reasoning about forward proxies for client requests</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-servers"><a href="#type-servers" class="anchor"></a><code><span><span class="keyword">type</span> <span>('direct, 'tunnel) servers</span></span></code></div><div class="spec-doc"><p>A configuration for forward proxy servers</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>('direct, 'tunnel) t</span></span><span> = </span></code><ol><li id="type-t.Direct" class="def variant constructor anchored"><a href="#type-t.Direct" class="anchor"></a><code><span>| </span><span><span class="constructor">Direct</span> <span class="keyword">of</span> <span class="type-var">'direct</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A proxy providing direct forwarding</p><span class="comment-delim">*)</span></div></li><li id="type-t.Tunnel" class="def variant constructor anchored"><a href="#type-t.Tunnel" class="anchor"></a><code><span>| </span><span><span class="constructor">Tunnel</span> <span class="keyword">of</span> <span class="type-var">'tunnel</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A proxy using a tunnel (i.e. for https connections))</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>A forward proxying connection</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_servers"><a href="#val-make_servers" class="anchor"></a><code><span><span class="keyword">val</span> make_servers :
|
||
<span><span class="label">no_proxy_patterns</span>:<span>string option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">default_proxy</span>:<span><a href="../../../../uri/Uri/index.html#type-t">Uri.t</a> option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">scheme_proxies</span>:<span><span>(string * <a href="../../../../uri/Uri/index.html#type-t">Uri.t</a>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">direct</span>:<span>(<span><a href="../../../../uri/Uri/index.html#type-t">Uri.t</a> <span class="arrow">-></span></span> <span class="type-var">'direct</span>)</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">tunnel</span>:<span>(<span><a href="../../../../uri/Uri/index.html#type-t">Uri.t</a> <span class="arrow">-></span></span> <span class="type-var">'tunnel</span>)</span> <span class="arrow">-></span></span>
|
||
<span><span>(<span class="type-var">'direct</span>, <span class="type-var">'tunnel</span>)</span> <a href="#type-servers">servers</a></span></span></code></div><div class="spec-doc"><p>Create a new configuration of proxy servers</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">no_proxy_patterns</span> <p>Disable proxies for specific hosts, specified as curl's <code>NO_PROXY</code>.</p></li></ul><ul class="at-tags"><li class="see"><span class="at-tag">see</span> <a href="https://github.com/curl/curl/blob/master/docs/MANUAL.md#environment-variables" class="value">https://github.com/curl/curl/blob/master/docs/MANUAL.md#environment-variables</a> </li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">default_proxy</span> <p>The default proxy to use. Proxy for specific schemes have precedence over this.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">scheme_proxies</span> <p>A mapping of (remote) scheme's to the desired proxy URI to user for calls with that scheme.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">direct</span> <p>A function to create <code>'direct</code> connections for the given proxy URI.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tunnel</span> <p>A function to create <code>'tunnel</code> connections for the given proxy URI.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><span><span>(<span class="type-var">'direct</span>, <span class="type-var">'tunnel</span>)</span> <a href="#type-servers">servers</a></span> <span class="arrow">-></span></span> <span><a href="../../../../uri/Uri/index.html#type-t">Uri.t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'direct</span>, <span class="type-var">'tunnel</span>)</span> <a href="#type-t">t</a></span> option</span></span></code></div><div class="spec-doc"><p><code>get proxies uri</code> finds the proxy configured for the <code>uri</code>, if there is one given <code>proxies</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">servers</span> <p>The configured proxy servers</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">uri</span> <p>The URI to find a proxy server for</p></li></ul></div></div></div></body></html>
|