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
89
90
91
92
93
94
95
96
97
98
99
100
|
<?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_ses_connect">
<refmeta>
<refentrytitle>ses_connect</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ses_connect</refname>
<refpurpose>Opens a TCP session and returns its handle.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_ses_connect">
<funcprototype id="fproto_ses_connect">
<funcdef>session_handle <function>ses_connect</function></funcdef>
<paramdef>in <parameter>host_and_port</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_ses_connect">
<title>Description</title>
<para>Requires dba privileges.</para>
<para>This function is used to establish a new TCP connection to the target
host. It returns a special datatype which represents the session handle.</para>
</refsect1>
<refsect1 id="params_ses_connect">
<title>Parameters</title>
<refsect2><title>host_and_port</title>
<para>The host and port number of the target host in the format
<host>[:<port>]. If the optional port number defaults to
80 if not supplied.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_ses_connect"><title>Return Types</title>
<para>Returns a special internal datatype that
represents the session handle. This session handle can be used in other
session functions. Since this is an internal type it cannot be stored.</para>
</refsect1>
<!--
<refsect1 id="errors_ses_connect">
<title>Errors</title>
<table>
<title>Errors signalled by</title>
<tgroup cols="4">
<thead>
<row>
<entry>SQLState</entry>
<entry>Error Code</entry>
<entry>Error Text</entry>
<entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_ses_connect">
<title>Examples</title>
<example id="ex_ses_connect"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_ses_connect">
<title>See Also</title>
<para><link linkend="fn_ses_disconnect"><function>ses_disconnect()</function></link></para>
<para><link linkend="fn_ses_read_line"><function>ses_read_line()</function></link></para>
<para><link linkend="fn_ses_write"><function>ses_write()</function></link></para>
</refsect1>
</refentry>
|
