/usr/share/doc/libcommons-net2-java/api/org/apache/commons/net/SocketClient.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 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 | <!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>SocketClient (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="SocketClient (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><a href="../../../../org/apache/commons/net/ProtocolCommandSupport.html" title="class in org.apache.commons.net"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/net/SocketClient.html" target="_top">Frames</a></li>
<li><a href="SocketClient.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 SocketClient" class="title">Class SocketClient</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.SocketClient</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/CharGenTCPClient.html" title="class in org.apache.commons.net.chargen">CharGenTCPClient</a>, <a href="../../../../org/apache/commons/net/daytime/DaytimeTCPClient.html" title="class in org.apache.commons.net.daytime">DaytimeTCPClient</a>, <a href="../../../../org/apache/commons/net/discard/DiscardTCPClient.html" title="class in org.apache.commons.net.discard">DiscardTCPClient</a>, <a href="../../../../org/apache/commons/net/finger/FingerClient.html" title="class in org.apache.commons.net.finger">FingerClient</a>, <a href="../../../../org/apache/commons/net/ftp/FTP.html" title="class in org.apache.commons.net.ftp">FTP</a>, <a href="../../../../org/apache/commons/net/nntp/NNTP.html" title="class in org.apache.commons.net.nntp">NNTP</a>, <a href="../../../../org/apache/commons/net/pop3/POP3.html" title="class in org.apache.commons.net.pop3">POP3</a>, <a href="../../../../org/apache/commons/net/bsd/RExecClient.html" title="class in org.apache.commons.net.bsd">RExecClient</a>, <a href="../../../../org/apache/commons/net/smtp/SMTP.html" title="class in org.apache.commons.net.smtp">SMTP</a>, <a href="../../../../org/apache/commons/net/telnet/TelnetClient.html" title="class in org.apache.commons.net.telnet">TelnetClient</a>, <a href="../../../../org/apache/commons/net/time/TimeTCPClient.html" title="class in org.apache.commons.net.time">TimeTCPClient</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">SocketClient</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 SocketClient provides the basic operations that are required of
client objects accessing 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/SocketClient.html#setSocketFactory(javax.net.SocketFactory)"><code>setSocketFactory </code></a>
method, which allows you to control the type of Socket the SocketClient
creates for initiating network connections. This is especially useful
for adding SSL or proxy support as well as better support for applets. For
example, you could create a
<a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net"><code>SocketFactory</code></a> that
requests browser security capabilities before creating a socket.
All classes derived from SocketClient should use the
<a href="../../../../org/apache/commons/net/SocketClient.html#_socketFactory_"><code>_socketFactory_ </code></a> member variable to
create Socket and ServerSocket instances rather than instanting
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.</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="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net"><code>SocketFactory</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 int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_defaultPort_">_defaultPort_</a></strong></code>
<div class="block">The default port the client should connect to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_input_">_input_</a></strong></code>
<div class="block">The socket's InputStream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_output_">_output_</a></strong></code>
<div class="block">The socket's OutputStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_serverSocketFactory_">_serverSocketFactory_</a></strong></code>
<div class="block">The socket's ServerSocket Factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_socket_">_socket_</a></strong></code>
<div class="block">The socket used for the connection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net">SocketFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_socketFactory_">_socketFactory_</a></strong></code>
<div class="block">The socket's SocketFactory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_timeout_">_timeout_</a></strong></code>
<div class="block">The timeout to use after opening a socket.</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/SocketClient.html#connectTimeout">connectTimeout</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#NETASCII_EOL">NETASCII_EOL</a></strong></code>
<div class="block">The end of line character sequence used by most IETF protocols.</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/SocketClient.html#SocketClient()">SocketClient</a></strong>()</code>
<div class="block">Default constructor for SocketClient.</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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()">_connectAction_</a></strong>()</code>
<div class="block">Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately
after establishing a connection, rather than reimplementing all
of the connect() methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress)">connect</a></strong>(<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> host)</code>
<div class="block">Opens a Socket connected to a remote host at the current default port
and originating from the current host at a system assigned 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/SocketClient.html#connect(java.net.InetAddress, int)">connect</a></strong>(<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> host,
int port)</code>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the current host at a system assigned 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/SocketClient.html#connect(java.net.InetAddress, int, java.net.InetAddress, int)">connect</a></strong>(<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> host,
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> localAddr,
int localPort)</code>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the specified local address and 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/SocketClient.html#connect(java.lang.String)">connect</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname)</code>
<div class="block">Opens a Socket connected to a remote host at the current default
port and originating from the current host at a system assigned 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/SocketClient.html#connect(java.lang.String, int)">connect</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname,
int port)</code>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the current host at a system assigned 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/SocketClient.html#connect(java.lang.String, int, java.net.InetAddress, int)">connect</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname,
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> localAddr,
int localPort)</code>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the specified local address and 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/SocketClient.html#disconnect()">disconnect</a></strong>()</code>
<div class="block">Disconnects the socket 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/SocketClient.html#getConnectTimeout()">getConnectTimeout</a></strong>()</code>
<div class="block">Get the underlying socket connection timeout.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#getDefaultPort()">getDefaultPort</a></strong>()</code>
<div class="block">Returns the current value of the default port (stored in
<a href="../../../../org/apache/commons/net/SocketClient.html#_defaultPort_"><code>_defaultPort_ </code></a>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.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="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#getKeepAlive()">getKeepAlive</a></strong>()</code>
<div class="block">Returns the current value of the SO_KEEPALIVE flag on the currently opened 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/SocketClient.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/SocketClient.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><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/SocketClient.html#getRemoteAddress()">getRemoteAddress</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#getRemotePort()">getRemotePort</a></strong>()</code>
<div class="block">Returns the port number of the remote host to which the client is
connected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#getServerSocketFactory()">getServerSocketFactory</a></strong>()</code>
<div class="block">Get the underlying <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net"><code>ServerSocketFactory</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#getSoLinger()">getSoLinger</a></strong>()</code>
<div class="block">Returns the current SO_LINGER timeout of the currently opened socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.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/SocketClient.html#getTcpNoDelay()">getTcpNoDelay</a></strong>()</code>
<div class="block">Returns true if Nagle's algorithm is enabled on the currently opened
socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#isConnected()">isConnected</a></strong>()</code>
<div class="block">Returns true if the client is currently connected to a server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setConnectTimeout(int)">setConnectTimeout</a></strong>(int connectTimeout)</code>
<div class="block">Sets the connection timeout in milliseconds, which will be passed to the <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/Socket.html?is-external=true" title="class or interface in java.net"><code>Socket</code></a> object's
connect() method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setDefaultPort(int)">setDefaultPort</a></strong>(int port)</code>
<div class="block">Sets the default port the SocketClient should connect to when a port
is not specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.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="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setKeepAlive(boolean)">setKeepAlive</a></strong>(boolean keepAlive)</code>
<div class="block">Sets the SO_KEEPALIVE flag on the currently opened 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/SocketClient.html#setReceiveBufferSize(int)">setReceiveBufferSize</a></strong>(int size)</code>
<div class="block">Sets the underlying socket receive buffer size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setSendBufferSize(int)">setSendBufferSize</a></strong>(int size)</code>
<div class="block">Set the underlying socket send buffer size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setServerSocketFactory(javax.net.ServerSocketFactory)">setServerSocketFactory</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a> factory)</code>
<div class="block">Sets the ServerSocketFactory used by the SocketClient to open ServerSocket
connections.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setSocketFactory(javax.net.SocketFactory)">setSocketFactory</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net">SocketFactory</a> factory)</code>
<div class="block">Sets the SocketFactory used by the SocketClient to open socket
connections.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setSoLinger(boolean, int)">setSoLinger</a></strong>(boolean on,
int val)</code>
<div class="block">Sets the SO_LINGER timeout on the currently opened 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/SocketClient.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>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#setTcpNoDelay(boolean)">setTcpNoDelay</a></strong>(boolean on)</code>
<div class="block">Enables or disables the Nagle's algorithm (TCP_NODELAY) on the
currently opened socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/net/SocketClient.html#verifyRemote(java.net.Socket)">verifyRemote</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> socket)</code>
<div class="block">Verifies that the remote end of the given socket is connected to the
the same host that the SocketClient is currently connected to.</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="NETASCII_EOL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NETASCII_EOL</h4>
<pre>public static final <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NETASCII_EOL</pre>
<div class="block">The end of line character sequence used by most IETF protocols. That
is a carriage return followed by a newline: "\r\n"</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.commons.net.SocketClient.NETASCII_EOL">Constant Field Values</a></dd></dl>
</li>
</ul>
<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/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> _socket_</pre>
<div class="block">The socket used for the connection.</div>
</li>
</ul>
<a name="_defaultPort_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_defaultPort_</h4>
<pre>protected int _defaultPort_</pre>
<div class="block">The default port the client should connect to.</div>
</li>
</ul>
<a name="_input_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_input_</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> _input_</pre>
<div class="block">The socket's InputStream.</div>
</li>
</ul>
<a name="_output_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_output_</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> _output_</pre>
<div class="block">The socket's OutputStream.</div>
</li>
</ul>
<a name="_socketFactory_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_socketFactory_</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net">SocketFactory</a> _socketFactory_</pre>
<div class="block">The socket's SocketFactory.</div>
</li>
</ul>
<a name="_serverSocketFactory_">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_serverSocketFactory_</h4>
<pre>protected <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a> _serverSocketFactory_</pre>
<div class="block">The socket's ServerSocket Factory.</div>
</li>
</ul>
<a name="connectTimeout">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>connectTimeout</h4>
<pre>protected int connectTimeout</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SocketClient()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SocketClient</h4>
<pre>public SocketClient()</pre>
<div class="block">Default constructor for SocketClient. Initializes
_socket_ to null, _timeout_ to 0, _defaultPort to 0,
_isConnected_ to false, and _socketFactory_ to a shared instance of
<a href="../../../../org/apache/commons/net/DefaultSocketFactory.html" title="class in org.apache.commons.net"><code>DefaultSocketFactory</code></a>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="_connectAction_()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_connectAction_</h4>
<pre>protected void _connectAction_()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Because there are so many connect() methods, the _connectAction_()
method is provided as a means of performing some action immediately
after establishing a connection, rather than reimplementing all
of the connect() methods. The last action performed by every
connect() method after opening a socket is to call this method.
<p>
This method sets the timeout on the just opened socket to the default
timeout set by <a href="../../../../org/apache/commons/net/SocketClient.html#setDefaultTimeout(int)"><code>setDefaultTimeout() </code></a>,
sets _input_ and _output_ to the socket's InputStream and OutputStream
respectively, and sets _isConnected_ to true.
<p>
Subclasses overriding this method should start by calling
<code> super._connectAction_() </code> first to ensure the
initialization of the aforementioned protected variables.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="connect(java.net.InetAddress, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<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> host,
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the current host at a system assigned port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - The remote host.</dd><dd><code>port</code> - The port to connect to on the remote host.</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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd></dl>
</li>
</ul>
<a name="connect(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname,
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the current host at a system assigned port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hostname</code> - The name of the remote host.</dd><dd><code>port</code> - The port to connect to on the remote host.</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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></code> - If the hostname cannot be resolved.</dd></dl>
</li>
</ul>
<a name="connect(java.net.InetAddress, int, java.net.InetAddress, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<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> host,
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> localAddr,
int localPort)
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the specified local address and port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - The remote host.</dd><dd><code>port</code> - The port to connect to on the remote host.</dd><dd><code>localAddr</code> - The local address to use.</dd><dd><code>localPort</code> - The local port 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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd></dl>
</li>
</ul>
<a name="connect(java.lang.String, int, java.net.InetAddress, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname,
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> localAddr,
int localPort)
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the specified port and
originating from the specified local address and port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hostname</code> - The name of the remote host.</dd><dd><code>port</code> - The port to connect to on the remote host.</dd><dd><code>localAddr</code> - The local address to use.</dd><dd><code>localPort</code> - The local port 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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></code> - If the hostname cannot be resolved.</dd></dl>
</li>
</ul>
<a name="connect(java.net.InetAddress)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<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> host)
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the current default port
and originating from the current host at a system assigned port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - The remote host.</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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd></dl>
</li>
</ul>
<a name="connect(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public void connect(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostname)
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>,
<a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Opens a Socket connected to a remote host at the current default
port and originating from the current host at a system assigned port.
Before returning, <a href="../../../../org/apache/commons/net/SocketClient.html#_connectAction_()"><code>_connectAction_() </code></a>
is called to perform connection initialization actions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hostname</code> - The name of the remote host.</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 timeout could not be set.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If the socket could not be opened. In most
cases you will only want to catch IOException since SocketException is
derived from it.</dd>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a></code> - If the hostname cannot be resolved.</dd></dl>
</li>
</ul>
<a name="disconnect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre>public void disconnect()
throws <a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Disconnects the socket 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/SocketClient.html#connect(java.net.InetAddress, int)"><code>connect() </code></a>
again. _isConnected_ is set to false, _socket_ is set to null,
_input_ is set to null, and _output_ is set to null.
<p></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error closing the socket.</dd></dl>
</li>
</ul>
<a name="isConnected()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>public boolean isConnected()</pre>
<div class="block">Returns true if the client is currently connected to a server.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if the client is currently connected to a server,
false otherwise.</dd></dl>
</li>
</ul>
<a name="setDefaultPort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultPort</h4>
<pre>public void setDefaultPort(int port)</pre>
<div class="block">Sets the default port the SocketClient should connect to when a port
is not specified. The <a href="../../../../org/apache/commons/net/SocketClient.html#_defaultPort_"><code>_defaultPort_ </code></a>
variable stores this value. If never set, the default port is equal
to zero.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - The default port to set.</dd></dl>
</li>
</ul>
<a name="getDefaultPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultPort</h4>
<pre>public int getDefaultPort()</pre>
<div class="block">Returns the current value of the default port (stored in
<a href="../../../../org/apache/commons/net/SocketClient.html#_defaultPort_"><code>_defaultPort_ </code></a>).
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current value of the default port.</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.
This value is only used previous to a call to
<a href="../../../../org/apache/commons/net/SocketClient.html#connect(java.net.InetAddress, int)"><code>connect()</code></a>
and should not be confused with <a href="../../../../org/apache/commons/net/SocketClient.html#setSoTimeout(int)"><code>setSoTimeout()</code></a>
which operates on an the currently opened 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 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/SocketClient.html#connect(java.net.InetAddress, int)"><code>connect()</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 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> - If the operation fails.</dd></dl>
</li>
</ul>
<a name="setSendBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSendBufferSize</h4>
<pre>public void setSendBufferSize(int size)
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 underlying socket send buffer size.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - The size of the buffer in bytes.</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><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="setReceiveBufferSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveBufferSize</h4>
<pre>public void setReceiveBufferSize(int size)
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">Sets the underlying socket receive buffer size.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - The size of the buffer in bytes.</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><dt><span class="strong">Since:</span></dt>
<dd>2.0</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.
<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> - If the operation fails.</dd></dl>
</li>
</ul>
<a name="setTcpNoDelay(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTcpNoDelay</h4>
<pre>public void setTcpNoDelay(boolean on)
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">Enables or disables the Nagle's algorithm (TCP_NODELAY) on the
currently opened socket.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>on</code> - True if Nagle's algorithm is to be enabled, false if not.</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 operation fails.</dd></dl>
</li>
</ul>
<a name="getTcpNoDelay()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTcpNoDelay</h4>
<pre>public boolean getTcpNoDelay()
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 true if Nagle's algorithm is enabled on the currently opened
socket.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if Nagle's algorithm is enabled on the currently opened
socket, false otherwise.</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 operation fails.</dd></dl>
</li>
</ul>
<a name="setKeepAlive(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeepAlive</h4>
<pre>public void setKeepAlive(boolean keepAlive)
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">Sets the SO_KEEPALIVE flag on the currently opened socket.
From the Javadocs, the default keepalive time is 2 hours (although this is
implementation dependent). It looks as though the Windows WSA sockets implementation
allows a specific keepalive value to be set, although this seems not to be the case on
other systems.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keepAlive</code> - If true, keepAlive is turned on</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><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="getKeepAlive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeepAlive</h4>
<pre>public boolean getKeepAlive()
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 current value of the SO_KEEPALIVE flag on the currently opened socket.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if SO_KEEPALIVE is enabled.</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><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="setSoLinger(boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSoLinger</h4>
<pre>public void setSoLinger(boolean on,
int val)
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">Sets the SO_LINGER timeout on the currently opened socket.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>on</code> - True if linger is to be enabled, false if not.</dd><dd><code>val</code> - The linger timeout (in hundredths of a second?)</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 operation fails.</dd></dl>
</li>
</ul>
<a name="getSoLinger()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSoLinger</h4>
<pre>public int getSoLinger()
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 current SO_LINGER timeout of the currently opened socket.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current SO_LINGER timeout. If SO_LINGER is disabled returns
-1.</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 operation fails.</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.
<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.
<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="getRemotePort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemotePort</h4>
<pre>public int getRemotePort()</pre>
<div class="block">Returns the port number of the remote host to which the client is
connected.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The port number of the remote host to which the client is
connected.</dd></dl>
</li>
</ul>
<a name="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</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> getRemoteAddress()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>The remote address to which the client is connected.</dd></dl>
</li>
</ul>
<a name="verifyRemote(java.net.Socket)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyRemote</h4>
<pre>public boolean verifyRemote(<a href="file:///usr/share/doc/default-jdk-doc/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> socket)</pre>
<div class="block">Verifies that the remote end of the given socket is connected to the
the same host that the SocketClient is currently connected to. This
is useful for doing a quick security check when a client needs to
accept a connection from a server, such as an FTP data connection or
a BSD R command standard error stream.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if the remote hosts are the same, false if not.</dd></dl>
</li>
</ul>
<a name="setSocketFactory(javax.net.SocketFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSocketFactory</h4>
<pre>public void setSocketFactory(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/SocketFactory.html?is-external=true" title="class or interface in javax.net">SocketFactory</a> factory)</pre>
<div class="block">Sets the SocketFactory used by the SocketClient to open socket
connections. 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 SocketFactory the SocketClient should use.</dd></dl>
</li>
</ul>
<a name="setServerSocketFactory(javax.net.ServerSocketFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServerSocketFactory</h4>
<pre>public void setServerSocketFactory(<a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a> factory)</pre>
<div class="block">Sets the ServerSocketFactory used by the SocketClient to open ServerSocket
connections. 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 ServerSocketFactory the SocketClient should use.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="setConnectTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectTimeout</h4>
<pre>public void setConnectTimeout(int connectTimeout)</pre>
<div class="block">Sets the connection timeout in milliseconds, which will be passed to the <a href="file:///usr/share/doc/default-jdk-doc/api/java/net/Socket.html?is-external=true" title="class or interface in java.net"><code>Socket</code></a> object's
connect() method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>connectTimeout</code> - The connection timeout to use (in ms)</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="getConnectTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectTimeout</h4>
<pre>public int getConnectTimeout()</pre>
<div class="block">Get the underlying socket connection timeout.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>timeout (in ms)</dd><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd></dl>
</li>
</ul>
<a name="getServerSocketFactory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServerSocketFactory</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net">ServerSocketFactory</a> getServerSocketFactory()</pre>
<div class="block">Get the underlying <a href="file:///usr/share/doc/default-jdk-doc/api/javax/net/ServerSocketFactory.html?is-external=true" title="class or interface in javax.net"><code>ServerSocketFactory</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The server socket factory</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</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><a href="../../../../org/apache/commons/net/ProtocolCommandSupport.html" title="class in org.apache.commons.net"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/net/SocketClient.html" target="_top">Frames</a></li>
<li><a href="SocketClient.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>
|