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
101
102
103
104
105
106
107
108
109
110
111
|
<?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_serv_queue_top">
<refmeta>
<refentrytitle>SERV_QUEUE_TOP</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>SERV_QUEUE_TOP</refname>
<refpurpose>Retrieve target website and store within Virtuoso</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_serv_queue_top">
<funcprototype id="fproto_serv_queue_top">
<funcdef>WS.WS.<function>SERV_QUEUE_TOP</function></funcdef>
<paramdef>in <parameter>target</parameter> varchar</paramdef>
<paramdef>in <parameter>WebDAV_collection</parameter> varchar</paramdef>
<paramdef>in <parameter>update</parameter> integer</paramdef>
<paramdef>in <parameter>debug</parameter> integer</paramdef>
<paramdef>in <parameter>function_hook</parameter> varchar</paramdef>
<paramdef>in <parameter>data</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_serv_queue_top"><title>Description</title>
<para>Web Robot site retrieval can be performed with the WS.WS.SERV_QUEUE_TOP PL function
integrated in to the Virtuoso server.</para>
<para>
To run multiple walking robots all you simply need to do is kick them off from
separate ODBC/SQL connections and all robots will walk together without overlapping.
</para>
<para>
From a VSP interface, after calling the retrieval function you may
call <link linkend="fn_http_flush">http_flush</link> to keep running tasks
in the server and allowing the user agent to continue with other tasks.
</para>
</refsect1>
<refsect1 id="params_serv_queue_top"><title>Parameters</title>
<refsect2><title>target</title>
<para>URI to target site.</para></refsect2>
<refsect2><title>WebDAV_collection</title>
<para>Local WebDAV collection to copy the content to.</para></refsect2>
<refsect2><title>update</title>
<para>Flag to set updatable, can be 1 or 0 for on or off respectably.</para></refsect2>
<refsect2><title>debug</title>
<para>Debug flag, must be set to 0</para></refsect2>
<refsect2><title>function_hook.</title>
<para>Fully qualified PL function hook name. If not supplied or NULL then
the default function will be used.</para></refsect2>
<refsect2><title>data</title>
<para>application dependent data, usually an array, is passed to the PL function
hook to perform next queue entry extraction. In our example we use an array with
names of non-desired sites.
</para></refsect2>
</refsect1>
<!--
<refsect1 id="ret_serv_queue_top"><title>Return Types</title><para></para></refsect1>
<refsect1 id="errors_serv_queue_top"><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_serv_queue_top"><title>Examples</title>
<example id="ex_serv_queue_top"><title>Retrieve External Sites</title>
<programlisting>
WS.WS.SERV_QUEUE_TOP (
'www.foo.com', 'sites/www_foo_com', 0, 0, 'DB.DBA.my_hook',
vector ('www.skip.me','www.bar.com')
);
</programlisting>
</example>
</refsect1>
<!--
<refsect1 id="seealso_serv_queue_top"><title>See Also</title>
<para><link linkend="fn"></link></para>
</refsect1>
-->
</refentry>
|
