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
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?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_client_ip">
<refmeta>
<refentrytitle>http_client_ip</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_client_ip</refname>
<refpurpose>Returns the IP address of the calling client.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_client_ip">
<funcprototype id="fproto_http_client_ip">
<funcdef>varchar <function>http_client_ip</function></funcdef>
<paramdef><optional>in <parameter>what</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_client_ip">
<title>Description</title>
<para>This function is used to determine the IP address or DNS name of
the calling client.
</para>
<para>Please note that this function is slow when resolving a DNS names.
It is advisable to use IP addresses to to make applications faster.</para>
</refsect1>
<refsect1 id="params_http_client_ip">
<title>Parameters</title>
<refsect2><title>what</title>
<para>a flag designating what to return: </para>
<simplelist>
<member>0 - (default) : IP number of a client</member>
<member>1 - DNS name if it can be resolved; if no reverse DNS record can be found
then the IP number will be returned.</member>
</simplelist>
</refsect2>
</refsect1>
<refsect1 id="ret_http_client_ip"><title>Return Types</title>
<para>
By default, a string of the dotted IP address of the client user agent.
If what=1 then the DNS name will be returned.</para>
</refsect1>
<refsect1 id="seealso_http_client_ip"><title>See Also</title>
<para>
<link linkend="fn_http"><function>http</function></link>,
<link linkend="fn_http_value"><function>http_value</function></link>,
<link linkend="fn_http_url"><function>http_url</function></link>,
<link linkend="fn_string_output"><function>string_output</function></link>,
<link linkend="fn_http_acl_get"><function>http_acl_get</function></link>,
<link linkend="fn_http_rewrite"><function>http_rewrite</function></link>.
</para>
</refsect1>
<refsect1 id="examples_http_client_ip"><title>Examples</title>
<example id="ex_http_client_ip"><title>Obtaining the Client IP Address</title>
<programlisting>
<?vsp
declare ip varchar;
ip := http_client_ip ();
http (sprintf ('<p>Your IP address is: %s</p>', ip));
?>
</programlisting>
</example>
</refsect1>
</refentry>
|
