/usr/share/doc/libcommons-net2-java/api/org/apache/commons/net/DatagramSocketClient.html is in libcommons-net2-java-doc 2.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Wed May 30 10:19:42 UTC 2012 -->
<title>DatagramSocketClient (libcommons-net2-java API)</title>
<meta name="date" content="2012-05-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DatagramSocketClient (libcommons-net2-java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/net/DatagramSocketClient.html" target="_top">Frames</a></li>
<li><a href="DatagramSocketClient.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.net</div>
<h2 title="Class DatagramSocketClient" class="title">Class DatagramSocketClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.net.DatagramSocketClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/commons/net/chargen/CharGenUDPClient.html" title="class in org.apache.commons.net.chargen">CharGenUDPClient</a>, <a href="../../../../org/apache/commons/net/daytime/DaytimeUDPClient.html" title="class in org.apache.commons.net.daytime">DaytimeUDPClient</a>, <a href="../../../../org/apache/commons/net/discard/DiscardUDPClient.html" title="class in org.apache.commons.net.discard">DiscardUDPClient</a>, <a href="../../../../org/apache/commons/net/ntp/NTPUDPClient.html" title="class in org.apache.commons.net.ntp">NTPUDPClient</a>, <a href="../../../../org/apache/commons/net/tftp/TFTP.html" title="class in org.apache.commons.net.tftp">TFTP</a>, <a href="../../../../org/apache/commons/net/time/TimeUDPClient.html" title="class in org.apache.commons.net.time">TimeUDPClient</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">DatagramSocketClient</span>
extends <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">The DatagramSocketClient provides the basic operations that are required
of client objects accessing datagram sockets. It is meant to be
subclassed to avoid having to rewrite the same code over and over again
to open a socket, close a socket, set timeouts, etc. Of special note
is the <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDatagramSocketFactory(org.apache.commons.net.DatagramSocketFactory)"><code>setDatagramSocketFactory </code></a>
method, which allows you to control the type of DatagramSocket the
DatagramSocketClient creates for network communications. This is
especially useful for adding things like proxy support as well as better
support for applets. For
example, you could create a
<a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net"><code>DatagramSocketFactory</code></a>
that
requests browser security capabilities before creating a socket.
All classes derived from DatagramSocketClient should use the
<a href="../../../../org/apache/commons/net/DatagramSocketClient.html#_socketFactory_"><code>_socketFactory_ </code></a> member variable to
create DatagramSocket instances rather than instantiating
them by directly invoking a constructor. By honoring this contract
you guarantee that a user will always be able to provide his own
Socket implementations by substituting his own SocketFactory.
<p>
<p></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Daniel F. Savarese</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net"><code>DatagramSocketFactory</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#_isOpen_">_isOpen_</a></strong></code>
<div class="block">A status variable indicating if the client's socket is currently open.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/DatagramSocket.html?is-external=true" title="class or interface in java.net">DatagramSocket</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#_socket_">_socket_</a></strong></code>
<div class="block">The datagram socket used for the connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net">DatagramSocketFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#_socketFactory_">_socketFactory_</a></strong></code>
<div class="block">The datagram socket's DatagramSocketFactory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#_timeout_">_timeout_</a></strong></code>
<div class="block">The timeout to use after opening a socket.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#DatagramSocketClient()">DatagramSocketClient</a></strong>()</code>
<div class="block">Default constructor for DatagramSocketClient.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#close()">close</a></strong>()</code>
<div class="block">Closes the DatagramSocket used for the connection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#getDefaultTimeout()">getDefaultTimeout</a></strong>()</code>
<div class="block">Returns the default timeout in milliseconds that is used when
opening a socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#getLocalAddress()">getLocalAddress</a></strong>()</code>
<div class="block">Returns the local address to which the client's socket is bound.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#getLocalPort()">getLocalPort</a></strong>()</code>
<div class="block">Returns the port number of the open socket on the local host used
for the connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#getSoTimeout()">getSoTimeout</a></strong>()</code>
<div class="block">Returns the timeout in milliseconds of the currently opened socket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#isOpen()">isOpen</a></strong>()</code>
<div class="block">Returns true if the client has a currently open socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open()">open</a></strong>()</code>
<div class="block">Opens a DatagramSocket on the local host at the first available port.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open(int)">open</a></strong>(int port)</code>
<div class="block">Opens a DatagramSocket on the local host at a specified port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open(int, java.net.InetAddress)">open</a></strong>(int port,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> laddr)</code>
<div class="block">Opens a DatagramSocket at the specified address on the local host
at a specified port.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDatagramSocketFactory(org.apache.commons.net.DatagramSocketFactory)">setDatagramSocketFactory</a></strong>(<a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net">DatagramSocketFactory</a> factory)</code>
<div class="block">Sets the DatagramSocketFactory used by the DatagramSocketClient
to open DatagramSockets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDefaultTimeout(int)">setDefaultTimeout</a></strong>(int timeout)</code>
<div class="block">Set the default timeout in milliseconds to use when opening a socket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setSoTimeout(int)">setSoTimeout</a></strong>(int timeout)</code>
<div class="block">Set the timeout in milliseconds of a currently open connection.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="_timeout_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_timeout_</h4>
<pre>protected int _timeout_</pre>
<div class="block">The timeout to use after opening a socket.</div>
</li>
</ul>
<a name="_socket_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_socket_</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/DatagramSocket.html?is-external=true" title="class or interface in java.net">DatagramSocket</a> _socket_</pre>
<div class="block">The datagram socket used for the connection.</div>
</li>
</ul>
<a name="_isOpen_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_isOpen_</h4>
<pre>protected boolean _isOpen_</pre>
<div class="block">A status variable indicating if the client's socket is currently open.</div>
</li>
</ul>
<a name="_socketFactory_">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_socketFactory_</h4>
<pre>protected <a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net">DatagramSocketFactory</a> _socketFactory_</pre>
<div class="block">The datagram socket's DatagramSocketFactory.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DatagramSocketClient()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatagramSocketClient</h4>
<pre>public DatagramSocketClient()</pre>
<div class="block">Default constructor for DatagramSocketClient. Initializes
_socket_ to null, _timeout_ to 0, and _isOpen_ to false.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="open()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public void open()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></pre>
<div class="block">Opens a DatagramSocket on the local host at the first available port.
Also sets the timeout on the socket to the default timeout set
by <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDefaultTimeout(int)"><code>setDefaultTimeout() </code></a>.
<p>
_isOpen_ is set to true after calling this method and _socket_
is set to the newly opened socket.
<p></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></code> - If the socket could not be opened or the
timeout could not be set.</dd></dl>
</li>
</ul>
<a name="open(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public void open(int port)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></pre>
<div class="block">Opens a DatagramSocket on the local host at a specified port.
Also sets the timeout on the socket to the default timeout set
by <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDefaultTimeout(int)"><code>setDefaultTimeout() </code></a>.
<p>
_isOpen_ is set to true after calling this method and _socket_
is set to the newly opened socket.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - The port to use for the socket.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></code> - If the socket could not be opened or the
timeout could not be set.</dd></dl>
</li>
</ul>
<a name="open(int, java.net.InetAddress)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public void open(int port,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> laddr)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></pre>
<div class="block">Opens a DatagramSocket at the specified address on the local host
at a specified port.
Also sets the timeout on the socket to the default timeout set
by <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setDefaultTimeout(int)"><code>setDefaultTimeout() </code></a>.
<p>
_isOpen_ is set to true after calling this method and _socket_
is set to the newly opened socket.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - The port to use for the socket.</dd><dd><code>laddr</code> - The local address to use.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></code> - If the socket could not be opened or the
timeout could not be set.</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block">Closes the DatagramSocket used for the connection.
You should call this method after you've finished using the class
instance and also before you call <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open()"><code>open() </code></a>
again. _isOpen_ is set to false and _socket_ is set to null.
If you call this method when the client socket is not open,
a NullPointerException is thrown.</div>
</li>
</ul>
<a name="isOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOpen</h4>
<pre>public boolean isOpen()</pre>
<div class="block">Returns true if the client has a currently open socket.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if the client has a curerntly open socket, false otherwise.</dd></dl>
</li>
</ul>
<a name="setDefaultTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultTimeout</h4>
<pre>public void setDefaultTimeout(int timeout)</pre>
<div class="block">Set the default timeout in milliseconds to use when opening a socket.
After a call to open, the timeout for the socket is set using this value.
This method should be used prior to a call to <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open()"><code>open()</code></a>
and should not be confused with <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#setSoTimeout(int)"><code>setSoTimeout()</code></a>
which operates on the currently open socket. _timeout_ contains
the new timeout value.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - The timeout in milliseconds to use for the datagram socket
connection.</dd></dl>
</li>
</ul>
<a name="getDefaultTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultTimeout</h4>
<pre>public int getDefaultTimeout()</pre>
<div class="block">Returns the default timeout in milliseconds that is used when
opening a socket.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default timeout in milliseconds that is used when
opening a socket.</dd></dl>
</li>
</ul>
<a name="setSoTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSoTimeout</h4>
<pre>public void setSoTimeout(int timeout)
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></pre>
<div class="block">Set the timeout in milliseconds of a currently open connection.
Only call this method after a connection has been opened
by <a href="../../../../org/apache/commons/net/DatagramSocketClient.html#open()"><code>open()</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - The timeout in milliseconds to use for the currently
open datagram socket connection.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></code></dd></dl>
</li>
</ul>
<a name="getSoTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSoTimeout</h4>
<pre>public int getSoTimeout()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></pre>
<div class="block">Returns the timeout in milliseconds of the currently opened socket.
If you call this method when the client socket is not open,
a NullPointerException is thrown.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The timeout in milliseconds of the currently opened socket.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/SocketException.html?is-external=true" title="class or interface in java.net">SocketException</a></code></dd></dl>
</li>
</ul>
<a name="getLocalPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalPort</h4>
<pre>public int getLocalPort()</pre>
<div class="block">Returns the port number of the open socket on the local host used
for the connection. If you call this method when the client socket
is not open, a NullPointerException is thrown.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The port number of the open socket on the local host used
for the connection.</dd></dl>
</li>
</ul>
<a name="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> getLocalAddress()</pre>
<div class="block">Returns the local address to which the client's socket is bound.
If you call this method when the client socket is not open, a
NullPointerException is thrown.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The local address to which the client's socket is bound.</dd></dl>
</li>
</ul>
<a name="setDatagramSocketFactory(org.apache.commons.net.DatagramSocketFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDatagramSocketFactory</h4>
<pre>public void setDatagramSocketFactory(<a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net">DatagramSocketFactory</a> factory)</pre>
<div class="block">Sets the DatagramSocketFactory used by the DatagramSocketClient
to open DatagramSockets. If the factory value is null, then a default
factory is used (only do this to reset the factory after having
previously altered it).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - The new DatagramSocketFactory the DatagramSocketClient
should use.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/commons/net/DatagramSocketFactory.html" title="interface in org.apache.commons.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/net/DatagramSocketClient.html" target="_top">Frames</a></li>
<li><a href="DatagramSocketClient.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|