source: trunk/Packages/synapse/docs/help/blcksock.TUDPBlockSocket.html

Last change on this file was 2, checked in by chronos, 12 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 9.8 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 TUDPBlockSocket</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="TUDPBlockSocket"></a><h1 class="cio">Class TUDPBlockSocket</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 TUDPBlockSocket = class(<a class="normal" href="blcksock.TDgramBlockSocket.html">TDgramBlockSocket</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of UDP socket.</p>
23<p>
24 NOTE: in this class is all receiving redirected to RecvBufferFrom. You can use for reading any receive function. Preffered is RecvPacket! Similary all sending is redirected to SendbufferTo. You can use for sending UDP packet any sending function, like SendString.
25
26<p>Supported features: IPv4, IPv6, unicasts, broadcasts, multicasts, SOCKS5 proxy (only unicasts! Outgoing and incomming.)</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.TBlockSocket.html">TBlockSocket</a></li>
30<li class="ancestor"><a class="normal" href="blcksock.TSocksBlockSocket.html">TSocksBlockSocket</a></li>
31<li class="ancestor"><a class="normal" href="blcksock.TDgramBlockSocket.html">TDgramBlockSocket</a></li>
32<li class="thisitem">TUDPBlockSocket</li></ul><h2 class="overview">Overview</h2>
33<a name="@Methods"></a><h3 class="summary">Methods</h3>
34<table class="summary">
35<tr class="list">
36<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
37<td class="itemcode"><code>destructor <b><a href="blcksock.TUDPBlockSocket.html#Destroy">Destroy</a></b>; override;</code></td>
38</tr>
39<tr class="list2">
40<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
41<td class="itemcode"><code>procedure <b><a href="blcksock.TUDPBlockSocket.html#EnableBroadcast">EnableBroadcast</a></b>(Value: Boolean);</code></td>
42</tr>
43<tr class="list">
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.TUDPBlockSocket.html#SendBufferTo">SendBufferTo</a></b>(Buffer: TMemory; Length: Integer): Integer; override;</code></td>
46</tr>
47<tr class="list2">
48<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
49<td class="itemcode"><code>function <b><a href="blcksock.TUDPBlockSocket.html#RecvBufferFrom">RecvBufferFrom</a></b>(Buffer: TMemory; Length: Integer): Integer; override;</code></td>
50</tr>
51<tr class="list">
52<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
53<td class="itemcode"><code>procedure <b><a href="blcksock.TUDPBlockSocket.html#AddMulticast">AddMulticast</a></b>(MCastIP:string);</code></td>
54</tr>
55<tr class="list2">
56<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
57<td class="itemcode"><code>procedure <b><a href="blcksock.TUDPBlockSocket.html#DropMulticast">DropMulticast</a></b>(MCastIP:string);</code></td>
58</tr>
59<tr class="list">
60<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
61<td class="itemcode"><code>procedure <b><a href="blcksock.TUDPBlockSocket.html#EnableMulticastLoop">EnableMulticastLoop</a></b>(Value: Boolean);</code></td>
62</tr>
63<tr class="list2">
64<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
65<td class="itemcode"><code>function <b><a href="blcksock.TUDPBlockSocket.html#GetSocketType">GetSocketType</a></b>: integer; override;</code></td>
66</tr>
67<tr class="list">
68<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
69<td class="itemcode"><code>function <b><a href="blcksock.TUDPBlockSocket.html#GetSocketProtocol">GetSocketProtocol</a></b>: integer; override;</code></td>
70</tr>
71</table>
72<a name="@Properties"></a><h3 class="summary">Properties</h3>
73<table class="summary">
74<tr class="list">
75<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
76<td class="itemcode"><code>property <b><a href="blcksock.TUDPBlockSocket.html#MulticastTTL">MulticastTTL</a></b>: Integer read GetMulticastTTL Write SetMulticastTTL;</code></td>
77</tr>
78</table>
79<h2 class="description">Description</h2>
80<h3 class="detail">Methods</h3>
81<table class="detail">
82<tr class="list">
83<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
84<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
85</tr>
86</table>
87&nbsp;<table class="detail">
88<tr class="list">
89<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
90<td class="itemcode"><a name="EnableBroadcast"></a><code>procedure <b>EnableBroadcast</b>(Value: Boolean);</code></td>
91</tr>
92</table>
93<p>
94Enable or disable sending of broadcasts. If seting OK, result is <code>True</code>. This method is not supported in SOCKS5 mode! IPv6 does not support broadcasts! In this case you must use Multicasts instead.</p>
95<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="SendBufferTo"></a><code>function <b>SendBufferTo</b>(Buffer: TMemory; Length: Integer): Integer; override;</code></td>
99</tr>
100</table>
101<p>
102See <a class="normal" href="blcksock.TBlockSocket.html">TBlockSocket</a>.<a class="normal" href="blcksock.TBlockSocket.html#SendBufferTo">SendBufferTo</a></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="RecvBufferFrom"></a><code>function <b>RecvBufferFrom</b>(Buffer: TMemory; Length: Integer): Integer; override;</code></td>
107</tr>
108</table>
109<p>
110See <a class="normal" href="blcksock.TBlockSocket.html">TBlockSocket</a>.<a class="normal" href="blcksock.TBlockSocket.html#RecvBufferFrom">RecvBufferFrom</a></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="AddMulticast"></a><code>procedure <b>AddMulticast</b>(MCastIP:string);</code></td>
115</tr>
116</table>
117<p>
118Add this socket to given multicast group. You cannot use Multicasts in SOCKS mode!</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="DropMulticast"></a><code>procedure <b>DropMulticast</b>(MCastIP:string);</code></td>
123</tr>
124</table>
125<p>
126Remove this socket from given multicast group.</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="EnableMulticastLoop"></a><code>procedure <b>EnableMulticastLoop</b>(Value: Boolean);</code></td>
131</tr>
132</table>
133<p>
134All sended multicast datagrams is loopbacked to your interface too. (you can read your sended datas.) You can disable this feature by this function. This function not working on some Windows systems!</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="GetSocketType"></a><code>function <b>GetSocketType</b>: integer; override;</code></td>
139</tr>
140</table>
141<p>
142Return value of socket type. For UDP return SOCK_DGRAM.</p>
143<table class="detail">
144<tr class="list">
145<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
146<td class="itemcode"><a name="GetSocketProtocol"></a><code>function <b>GetSocketProtocol</b>: integer; override;</code></td>
147</tr>
148</table>
149<p>
150Return value of protocol type for socket creation. For UDP return IPPROTO_UDP.</p>
151<h3 class="detail">Properties</h3>
152<table class="detail">
153<tr class="list">
154<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
155<td class="itemcode"><a name="MulticastTTL"></a><code>property <b>MulticastTTL</b>: Integer read GetMulticastTTL Write SetMulticastTTL;</code></td>
156</tr>
157</table>
158<p>
159Set Time-to-live value for multicasts packets. It define number of routers for transfer of datas. If you set this to 1 (dafault system value), then multicasts packet goes only to you local network. If you need transport multicast packet to worldwide, then increase this value, but be carefull, lot of routers on internet does not transport multicasts packets!</p>
160<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>
161</span>
162</body></html>
Note: See TracBrowser for help on using the repository browser.