1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_proxy">
<refmeta>
<refentrytitle>http_proxy</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_proxy</refname>
<refpurpose>proxy request to another host and return content to calling client</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_proxy">
<funcprototype id="fproto_http_proxy">
<funcdef><function>http_proxy</function></funcdef>
<paramdef>in <parameter>host</parameter> varchar</paramdef>
<paramdef>in <parameter>header</parameter> any</paramdef>
<paramdef>in <parameter>content</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_proxy"><title>Description</title>
<para>
This function is used to retrieve content from a foreign host and send
the response to the HTTP client of the page calling this. This is useful for re-routing a request to another server in the middle of a VSP page.
</para>
</refsect1>
<refsect1 id="params_http_proxy"><title>Parameters</title>
<refsect2><title>host</title>
<para>The fully-qualified host name or alias. If a target port is specified the
semi-column ':' character MUST be used as the separator. ('www.foo.com:8080')
</para></refsect2>
<refsect2><title>header</title>
<para>
an array consisting of the HTTP request header lines. Warning: Each line
MUST finish with <CR><LF> characters. This header lines will be
sent to the target server without any conversion.
</para></refsect2>
<refsect2><title>content</title>
<para>
In the case of posting of forms this parameter can contain the form data
as specified in HTML standards.
</para></refsect2>
</refsect1>
<refsect1 id="examples_http_proxy"><title>Examples</title>
<example id="ex_http_proxy"><title>Retrieving Current Path of Request</title>
<programlisting>
<?vsp
http_proxy ('www.foo.com', vector ('GET / HTTP/1.0'), null);
?>
</programlisting>
</example>
</refsect1>
</refentry>
|