source: trunk/Packages/synapse/docs/help/clamsend.TClamSend.html

Last change on this file was 2, checked in by chronos, 13 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 9.3 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2<html>
3<head>
4<meta name="GENERATOR" content="PasDoc 0.9.0">
5<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
6<title>clamsend: Class TClamSend</title>
7<link rel="StyleSheet" type="text/css" href="pasdoc.css">
8</head>
9<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
10<a name="TClamSend"></a><h1 class="cio">Class TClamSend</h1>
11<table class="sections">
12<tr>
13<td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#@Methods">Methods</a></td><td><a class="section" href="#@Properties">Properties</a></td></tr></table>
14<a name="@Description"></a><h2 class="unit">Unit</h2>
15<p class="unitlink">
16<a href="clamsend.html">clamsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TClamSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of ClamAV-daemon client protocol</p>
23<p>
24 By this class you can scan any your data by ClamAV opensource antivirus.
25
26<p>This class can connect to ClamD by TCP channel, send your data to ClamD and read result.</p>
27<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
28<ul class="hierarchy"><li class="ancestor">TObject</li>
29<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
30<li class="thisitem">TClamSend</li></ul><h2 class="overview">Overview</h2>
31<a name="@Methods"></a><h3 class="summary">Methods</h3>
32<table class="summary">
33<tr class="list">
34<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
35<td class="itemcode"><code>constructor <b><a href="clamsend.TClamSend.html#Create">Create</a></b>;</code></td>
36</tr>
37<tr class="list2">
38<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
39<td class="itemcode"><code>destructor <b><a href="clamsend.TClamSend.html#Destroy">Destroy</a></b>; override;</code></td>
40</tr>
41<tr class="list">
42<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
43<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#DoCommand">DoCommand</a></b>(const Value: AnsiString): AnsiString; virtual;</code></td>
44</tr>
45<tr class="list2">
46<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
47<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#GetVersion">GetVersion</a></b>: AnsiString; virtual;</code></td>
48</tr>
49<tr class="list">
50<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
51<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#ScanStrings">ScanStrings</a></b>(const Value: TStrings): AnsiString; virtual;</code></td>
52</tr>
53<tr class="list2">
54<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
55<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#ScanStream">ScanStream</a></b>(const Value: TStream): AnsiString; virtual;</code></td>
56</tr>
57<tr class="list">
58<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
59<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#ScanStrings2">ScanStrings2</a></b>(const Value: TStrings): AnsiString; virtual;</code></td>
60</tr>
61<tr class="list2">
62<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
63<td class="itemcode"><code>function <b><a href="clamsend.TClamSend.html#ScanStream2">ScanStream2</a></b>(const Value: TStream): AnsiString; virtual;</code></td>
64</tr>
65</table>
66<a name="@Properties"></a><h3 class="summary">Properties</h3>
67<table class="summary">
68<tr class="list">
69<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
70<td class="itemcode"><code>property <b><a href="clamsend.TClamSend.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
71</tr>
72<tr class="list2">
73<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
74<td class="itemcode"><code>property <b><a href="clamsend.TClamSend.html#DSock">DSock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FDSock;</code></td>
75</tr>
76<tr class="list">
77<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
78<td class="itemcode"><code>property <b><a href="clamsend.TClamSend.html#Session">Session</a></b>: boolean read FSession write FSession;</code></td>
79</tr>
80</table>
81<h2 class="description">Description</h2>
82<h3 class="detail">Methods</h3>
83<table class="detail">
84<tr class="list">
85<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
86<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
87</tr>
88</table>
89&nbsp;<table class="detail">
90<tr class="list">
91<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
92<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
93</tr>
94</table>
95&nbsp;<table class="detail">
96<tr class="list">
97<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
98<td class="itemcode"><a name="DoCommand"></a><code>function <b>DoCommand</b>(const Value: AnsiString): AnsiString; virtual;</code></td>
99</tr>
100</table>
101<p>
102Call any command to ClamD. Used internally by other methods.</p>
103<table class="detail">
104<tr class="list">
105<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
106<td class="itemcode"><a name="GetVersion"></a><code>function <b>GetVersion</b>: AnsiString; virtual;</code></td>
107</tr>
108</table>
109<p>
110Return ClamAV version and version of loaded databases.</p>
111<table class="detail">
112<tr class="list">
113<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
114<td class="itemcode"><a name="ScanStrings"></a><code>function <b>ScanStrings</b>(const Value: TStrings): AnsiString; virtual;</code></td>
115</tr>
116</table>
117<p>
118Scan content of TStrings.</p>
119<table class="detail">
120<tr class="list">
121<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
122<td class="itemcode"><a name="ScanStream"></a><code>function <b>ScanStream</b>(const Value: TStream): AnsiString; virtual;</code></td>
123</tr>
124</table>
125<p>
126Scan content of TStream.</p>
127<table class="detail">
128<tr class="list">
129<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
130<td class="itemcode"><a name="ScanStrings2"></a><code>function <b>ScanStrings2</b>(const Value: TStrings): AnsiString; virtual;</code></td>
131</tr>
132</table>
133<p>
134Scan content of TStrings by new 0.95 API.</p>
135<table class="detail">
136<tr class="list">
137<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
138<td class="itemcode"><a name="ScanStream2"></a><code>function <b>ScanStream2</b>(const Value: TStream): AnsiString; virtual;</code></td>
139</tr>
140</table>
141<p>
142Scan content of TStream by new 0.95 API.</p>
143<h3 class="detail">Properties</h3>
144<table class="detail">
145<tr class="list">
146<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
147<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
148</tr>
149</table>
150<p>
151Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.</p>
152<table class="detail">
153<tr class="list">
154<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
155<td class="itemcode"><a name="DSock"></a><code>property <b>DSock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FDSock;</code></td>
156</tr>
157</table>
158<p>
159Socket object used for TCP data transfer operation. Good for seting OnStatus hook, etc.</p>
160<table class="detail">
161<tr class="list">
162<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
163<td class="itemcode"><a name="Session"></a><code>property <b>Session</b>: boolean read FSession write FSession;</code></td>
164</tr>
165</table>
166<p>
167Can turn-on session mode of communication with ClamD. Default is <code>False</code>, because ClamAV developers design their TCP code very badly and session mode is broken now (CVS-20051031). Maybe ClamAV developers fix their bugs and this mode will be possible in future.</p>
168<hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:50</em>
169</span>
170</body></html>
Note: See TracBrowser for help on using the repository browser.