source: trunk/Packages/synapse/docs/help/blcksock.TSocksBlockSocket.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: 11.4 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>blcksock: Class TSocksBlockSocket</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="TSocksBlockSocket"></a><h1 class="cio">Class TSocksBlockSocket</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="blcksock.html">blcksock</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TSocksBlockSocket = class(<a class="normal" href="blcksock.TBlockSocket.html">TBlockSocket</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Support for SOCKS4 and SOCKS5 proxy</p>
23<p>
24 Layer with definition all necessary properties and functions for implementation SOCKS proxy client. Do not use this class directly.</p>
25<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
26<ul class="hierarchy"><li class="ancestor">TObject</li>
27<li class="ancestor"><a class="normal" href="blcksock.TBlockSocket.html">TBlockSocket</a></li>
28<li class="thisitem">TSocksBlockSocket</li></ul><h2 class="overview">Overview</h2>
29<a name="@Methods"></a><h3 class="summary">Methods</h3>
30<table class="summary">
31<tr class="list">
32<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
33<td class="itemcode"><code>constructor <b><a href="blcksock.TSocksBlockSocket.html#Create">Create</a></b>;</code></td>
34</tr>
35<tr class="list2">
36<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
37<td class="itemcode"><code>function <b><a href="blcksock.TSocksBlockSocket.html#SocksOpen">SocksOpen</a></b>: Boolean;</code></td>
38</tr>
39<tr class="list">
40<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
41<td class="itemcode"><code>function <b><a href="blcksock.TSocksBlockSocket.html#SocksRequest">SocksRequest</a></b>(Cmd: Byte; const IP, Port: string): Boolean;</code></td>
42</tr>
43<tr class="list2">
44<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
45<td class="itemcode"><code>function <b><a href="blcksock.TSocksBlockSocket.html#SocksResponse">SocksResponse</a></b>: Boolean;</code></td>
46</tr>
47</table>
48<a name="@Properties"></a><h3 class="summary">Properties</h3>
49<table class="summary">
50<tr class="list">
51<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
52<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#UsingSocks">UsingSocks</a></b>: Boolean read FUsingSocks;</code></td>
53</tr>
54<tr class="list2">
55<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
56<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksLastError">SocksLastError</a></b>: integer read FSocksLastError;</code></td>
57</tr>
58<tr class="list">
59<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
60<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksIP">SocksIP</a></b>: string read FSocksIP write FSocksIP;</code></td>
61</tr>
62<tr class="list2">
63<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
64<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksPort">SocksPort</a></b>: string read FSocksPort write FSocksPort;</code></td>
65</tr>
66<tr class="list">
67<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
68<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksUsername">SocksUsername</a></b>: string read FSocksUsername write FSocksUsername;</code></td>
69</tr>
70<tr class="list2">
71<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
72<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksPassword">SocksPassword</a></b>: string read FSocksPassword write FSocksPassword;</code></td>
73</tr>
74<tr class="list">
75<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
76<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksTimeout">SocksTimeout</a></b>: integer read FSocksTimeout write FSocksTimeout;</code></td>
77</tr>
78<tr class="list2">
79<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
80<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksResolver">SocksResolver</a></b>: Boolean read FSocksResolver write FSocksResolver;</code></td>
81</tr>
82<tr class="list">
83<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
84<td class="itemcode"><code>property <b><a href="blcksock.TSocksBlockSocket.html#SocksType">SocksType</a></b>: <a href="blcksock.html#TSocksType">TSocksType</a> read FSocksType write FSocksType;</code></td>
85</tr>
86</table>
87<h2 class="description">Description</h2>
88<h3 class="detail">Methods</h3>
89<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="Create"></a><code>constructor <b>Create</b>;</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="SocksOpen"></a><code>function <b>SocksOpen</b>: Boolean;</code></td>
99</tr>
100</table>
101<p>
102Open connection to SOCKS proxy and if <a class="normal" href="blcksock.TSocksBlockSocket.html#SocksUsername">SocksUsername</a> is set, do authorisation to proxy. This is needed only in special cases! (it is called internally!)</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="SocksRequest"></a><code>function <b>SocksRequest</b>(Cmd: Byte; const IP, Port: string): Boolean;</code></td>
107</tr>
108</table>
109<p>
110Send specified request to SOCKS proxy. This is needed only in special cases! (it is called internally!)</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="SocksResponse"></a><code>function <b>SocksResponse</b>: Boolean;</code></td>
115</tr>
116</table>
117<p>
118Receive response to previosly sended request. This is needed only in special cases! (it is called internally!)</p>
119<h3 class="detail">Properties</h3>
120<table class="detail">
121<tr class="list">
122<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
123<td class="itemcode"><a name="UsingSocks"></a><code>property <b>UsingSocks</b>: Boolean read FUsingSocks;</code></td>
124</tr>
125</table>
126<p>
127Is <code>True</code> when class is using SOCKS proxy.</p>
128<table class="detail">
129<tr class="list">
130<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
131<td class="itemcode"><a name="SocksLastError"></a><code>property <b>SocksLastError</b>: integer read FSocksLastError;</code></td>
132</tr>
133</table>
134<p>
135If SOCKS proxy failed, here is error code returned from SOCKS proxy.</p>
136<table class="detail">
137<tr class="list">
138<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
139<td class="itemcode"><a name="SocksIP"></a><code>property <b>SocksIP</b>: string read FSocksIP write FSocksIP;</code></td>
140</tr>
141</table>
142<p>
143Address of SOCKS server. If value is empty string, SOCKS support is disabled. Assingning any value to this property enable SOCKS mode. Warning: You cannot combine this mode with HTTP-tunneling mode!</p>
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="SocksPort"></a><code>property <b>SocksPort</b>: string read FSocksPort write FSocksPort;</code></td>
148</tr>
149</table>
150<p>
151Port of SOCKS server. Default value is '1080'.</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="SocksUsername"></a><code>property <b>SocksUsername</b>: string read FSocksUsername write FSocksUsername;</code></td>
156</tr>
157</table>
158<p>
159If you need authorisation on SOCKS server, set username here.</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="SocksPassword"></a><code>property <b>SocksPassword</b>: string read FSocksPassword write FSocksPassword;</code></td>
164</tr>
165</table>
166<p>
167If you need authorisation on SOCKS server, set password here.</p>
168<table class="detail">
169<tr class="list">
170<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
171<td class="itemcode"><a name="SocksTimeout"></a><code>property <b>SocksTimeout</b>: integer read FSocksTimeout write FSocksTimeout;</code></td>
172</tr>
173</table>
174<p>
175Specify timeout for communicatin with SOCKS server. Default is one minute.</p>
176<table class="detail">
177<tr class="list">
178<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
179<td class="itemcode"><a name="SocksResolver"></a><code>property <b>SocksResolver</b>: Boolean read FSocksResolver write FSocksResolver;</code></td>
180</tr>
181</table>
182<p>
183If <code>True</code>, all symbolic names of target hosts is not translated to IP's locally, but resolving is by SOCKS proxy. Default is <code>True</code>.</p>
184<table class="detail">
185<tr class="list">
186<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
187<td class="itemcode"><a name="SocksType"></a><code>property <b>SocksType</b>: <a href="blcksock.html#TSocksType">TSocksType</a> read FSocksType write FSocksType;</code></td>
188</tr>
189</table>
190<p>
191Specify SOCKS type. By default is used SOCKS5, but you can use SOCKS4 too. When you select SOCKS4, then if <a class="normal" href="blcksock.TSocksBlockSocket.html#SocksResolver">SocksResolver</a> is enabled, then is used SOCKS4a. Othervise is used pure SOCKS4.</p>
192<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>
193</span>
194</body></html>
Note: See TracBrowser for help on using the repository browser.