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
|
<?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_client_attr">
<refmeta>
<refentrytitle>client_attr</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>client_attr</refname>
<refpurpose>returns a varchar containing the requested information from the connection</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_client_attr">
<funcprototype id="fprot_client_attr">
<funcdef>varchar <function>client_attr</function></funcdef>
<paramdef>in <parameter>attr</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="params_client_attr"><title>Parameters</title>
<refsect2><title>attr</title>
<para>can by one of the following:</para>
<simplelist>
<member><emphasis>client_protocol</emphasis> - returns connection protocol (HTTP/1.0, HTTP/1.1, SQL -- SQL corresponds to ODBC, JDBC, .net, OLEDB).</member>
<member><emphasis>client_ip </emphasis> - returns the IP where the invoking connection originates. 127.0.0.1 for
unix domain socket or internal scheduled task, otherwise the ip of the http or sql client.</member>
<member><emphasis>accepting_ip</emphasis> - returns the local listener through which the call came. If unix
domain socket or internal scheduled operation, this is 127.0.0.1</member>
<member><emphasis>client_application</emphasis> - returns the application name as sent by the driver. Empty string if unknown or internal.</member>
<member><emphasis>client_ssl</emphasis> - returns one if SSL encrypted connection either for SQL or HTTPS. False if internal or unix domain socket.</member>
<member><emphasis>client_certificate</emphasis> - If certificate based login, returns the certificate, null otherwise.</member>
<member><emphasis>transaction_log</emphasis> - 0 if the transaction log is off (turned on/off by <link linkend="fn_log_enable">log_enable ()</link>); 1 if on (default) .</member>
</simplelist>
</refsect2>
</refsect1>
<refsect1 id="errors_client_attr"><title>Errors</title>
<table><title>Errors signalled by <function>client_attr</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry>
</row>
</thead>
<tbody>
<row>
<entry><errorcode>22005</errorcode></entry>
<entry><errorcode>SR401</errorcode></entry>
<entry><errorname>Server address not known.</errorname></entry>
</row>
<row>
<entry><errorcode>22005</errorcode></entry>
<entry><errorcode>SR402</errorcode></entry>
<entry><errorname>Cannot allocate temp space. SSL error : xxx</errorname></entry>
</row>
<row>
<entry><errorcode>22005</errorcode></entry>
<entry><errorcode>SR403</errorcode></entry>
<entry><errorname>xxx is not valid client_attr option.</errorname></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
