/usr/share/doc/libpirl-java/api/PIRL/Image_Tools/HTTP_ImageInputStream.html is in libpirl-java-doc 2.3.8-1.
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 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 | <!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_09) on Tue Nov 20 23:14:17 UTC 2012 -->
<title>HTTP_ImageInputStream</title>
<meta name="date" content="2012-11-20">
<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="HTTP_ImageInputStream";
}
//-->
</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="../../PIRL/Image_Tools/Equirectangular_Projection.html" title="class in PIRL.Image_Tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.Range.html" title="class in PIRL.Image_Tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Image_Tools/HTTP_ImageInputStream.html" target="_top">Frames</a></li>
<li><a href="HTTP_ImageInputStream.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><a href="#nested_class_summary">Nested</a> | </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">PIRL.Image_Tools</div>
<h2 title="Class HTTP_ImageInputStream" class="title">Class HTTP_ImageInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/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><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">javax.imageio.stream.ImageInputStreamImpl</a></li>
<li>
<ul class="inheritance">
<li>PIRL.Image_Tools.HTTP_ImageInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="/usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">HTTP_ImageInputStream</span>
extends <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></pre>
<div class="block">An <i>HTTP_ImageInputStream</i> provides an <i>ImageInputStream</i>
interface to a remote source file accessed by a URL reference.
<p>
The URL used to reference the source file must use the http protocol.
Any HTTP server compatible with version 1.1 of the protocol should
be capable of providing selective access to the source file.
<p>
The source file data is buffered using a sliding window that is
mapped to an arbitrary location offset of the source file. Data is
fetched on demand using a Content_Range request to the server from
which the response data content is placed at the appropriate position
in the buffer. During normal read operations when the end of buffered
data is reached a relatively small input increment is fetched into
the buffer. When the amount of data has reached the buffer capacity
the buffer "slides" forward, dropping data from the beginning of the
buffer Arbitrary random access seeks within the source file are
supported. If the seek location is currently buffered, no data fetch
is needed, of course. Seeks beyond the range of buffered data to a
"nearby" location will retain as much buffered data as possible to
optimize short seeks.
<p>
If the connection to the server is lost repeated attempts are made
to reconnect. Reconnecting to the server does cause any loss of
buffered data.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream"><code>ImageInputStream</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.Range.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream.Range</a></strong></code>
<div class="block">A <i>Range</i> contains Start, End and Length values.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_BUFFER_SIZE">DEFAULT_BUFFER_SIZE</a></strong></code>
<div class="block">The default buffer capacity to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Allocate_Buffer(int)"><code>allocate</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_CONNECT_TIMEOUT">DEFAULT_CONNECT_TIMEOUT</a></strong></code>
<div class="block">The amount of time (ms) to wait for a server connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_PORT">DEFAULT_PORT</a></strong></code>
<div class="block">The default port to use for communication with the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_USER_AGENT">DEFAULT_USER_AGENT</a></strong></code>
<div class="block">The default <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)"><code>User Agent</code></a> reported to the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#ENCODING_SCHEME">ENCODING_SCHEME</a></strong></code>
<div class="block">The character encoding for messages sent to the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#HTTP_VERSION">HTTP_VERSION</a></strong></code>
<div class="block">The HTTP version identifier used in communication with the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#ID">ID</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#INPUT_INCREMENT">INPUT_INCREMENT</a></strong></code>
<div class="block">The amount of source data to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)"><code>fetch</code></a> when
performing an automatic refresh of buffer contents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#LOG_INPUT_PREFIX">LOG_INPUT_PREFIX</a></strong></code>
<div class="block">When <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging</code></a> is enabled, the prefix to
print before each response header line that is reported received
from the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#LOG_OUTPUT_PREFIX">LOG_OUTPUT_PREFIX</a></strong></code>
<div class="block">When <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging</code></a> is enabled, the prefix to
print before each request message line that is reported sent to the
server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#MAX_RECONNECT_ATTEMPTS">MAX_RECONNECT_ATTEMPTS</a></strong></code>
<div class="block">The maximum number of repeated server reconnect tries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#NO_SOURCE_SIZE">NO_SOURCE_SIZE</a></strong></code>
<div class="block">Source size value if no source has been found.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#RECONNECT_WAIT">RECONNECT_WAIT</a></strong></code>
<div class="block">The amount of time (ms) to wait before trying to reconnect with the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#SOURCE_NOT_FOUND_STATUS">SOURCE_NOT_FOUND_STATUS</a></strong></code>
<div class="block">HTTP <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a> code when the source can not be found
on the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_Size">Source_Size</a></strong></code>
<div class="block">Total size (bytes) of the source data file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#SUCCESS_STATUS_LIMIT">SUCCESS_STATUS_LIMIT</a></strong></code>
<div class="block">HTTP <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a> code value below which the request
is deemed successful.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_javax.imageio.stream.ImageInputStreamImpl">
<!-- -->
</a>
<h3>Fields inherited from class javax.imageio.stream.<a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#bitOffset" title="class or interface in javax.imageio.stream">bitOffset</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#byteOrder" title="class or interface in javax.imageio.stream">byteOrder</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#flushedPos" title="class or interface in javax.imageio.stream">flushedPos</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#streamPos" title="class or interface in javax.imageio.stream">streamPos</a></code></li>
</ul>
</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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#HTTP_ImageInputStream(java.net.URL)">HTTP_ImageInputStream</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</code>
<div class="block">Constructs an HTTP_ImageInputStream on a URL.</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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Allocate_Buffer(int)">Allocate_Buffer</a></strong>(int capacity)</code>
<div class="block">Allocates a data storage buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Buffer_Location()">Buffer_Location</a></strong>()</code>
<div class="block">Get the virtual source location of the beginning of the buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Buffer_Location(long)">Buffer_Location</a></strong>(long location)</code>
<div class="block">Set the virtual source location of the beginning of the buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Check_Source()">Check_Source</a></strong>()</code>
<div class="block">Check the server status of the source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#close()">close</a></strong>()</code>
<div class="block">All access to the source is closed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Connect(java.net.URL)">Connect</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</code>
<div class="block">Connect to the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Content_Length()">Content_Length</a></strong>()</code>
<div class="block">Get the length of server response data content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.Range.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream.Range</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Content_Range()">Content_Range</a></strong>()</code>
<div class="block">Get the Content-Range header values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Data_End_Location()">Data_End_Location</a></strong>()</code>
<div class="block">Get the virtual source location of the end (exclusive) of buffered
data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Data_End_Location(long)">Data_End_Location</a></strong>(long location)</code>
<div class="block">Set the virtual source location of the end (exclusive) of buffered
data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Default_User_Agent()">Default_User_Agent</a></strong>()</code>
<div class="block">Get the default user agent that will be used with new
HTTP_ImageInputStream objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Default_User_Agent(java.lang.String)">Default_User_Agent</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Set the default user agent that will be used with new
HTTP_ImageInputStream objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain()">Drain</a></strong>()</code>
<div class="block">Drain source data before the current stream position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain(int)">Drain</a></strong>(int amount)</code>
<div class="block">Drain data from the buffer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Empty()">Empty</a></strong>()</code>
<div class="block">Empty the buffer of all source data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#End_Request()">End_Request</a></strong>()</code>
<div class="block">Send the end-of-request sequence to the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)">Fetch</a></strong>(int amount)</code>
<div class="block">Fetch source data from the server (relative fetch).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(long, long)">Fetch</a></strong>(long start,
long end)</code>
<div class="block">Fetch source data from the server (absolute fetch).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#flushBefore(long)">flushBefore</a></strong>(long location)</code>
<div class="block">Discard buffered data before a source location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Header_Content(java.lang.String)">Header_Content</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Get the header content for a named header.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Header_Field(java.lang.String)">Header_Field</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Get the complete header field for a named header.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Header_Value(java.lang.String, int)">Header_Value</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
int value_index)</code>
<div class="block">Get a header field value by index within the field content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Header_Value(java.lang.String, java.lang.String)">Header_Value</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value_name)</code>
<div class="block">Get a header field value by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Headers()">Headers</a></strong>()</code>
<div class="block">Get the HTTP response headers from the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Image_Buffer_Range(long)">Image_Buffer_Range</a></strong>(long location)</code>
<div class="block">Clip a source location to the currently buffered data range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#in_Image_Buffer_Range(long)">in_Image_Buffer_Range</a></strong>(long location)</code>
<div class="block">Test if a source location is in the range of buffered data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#is_Closed()">is_Closed</a></strong>()</code>
<div class="block">Checks if the server connection is closed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#isCached()">isCached</a></strong>()</code>
<div class="block">Determine if the source data is cached.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#isCachedMemory()">isCachedMemory</a></strong>()</code>
<div class="block">Determine if the source data is cached in memory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#length()">length</a></strong>()</code>
<div class="block">Get the size of the source file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Location_for_Position(int)">Location_for_Position</a></strong>(int position)</code>
<div class="block">Convert a buffer position to a virtual source location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging()">Logging</a></strong>()</code>
<div class="block">Check if server communication logging is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)">Logging</a></strong>(boolean enabled)</code>
<div class="block">Enable or disable server communication logging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#main(java.lang.String[])">main</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Position_for_Location(long)">Position_for_Location</a></strong>(long location)</code>
<div class="block">Convert a virtual source location to a buffer position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#read()">read</a></strong>()</code>
<div class="block">Read a source byte.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#read(byte[], int, int)">read</a></strong>(byte[] data,
int offset,
int length)</code>
<div class="block">Read a sequence of source bytes and store them in an array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Receive()">Receive</a></strong>()</code>
<div class="block">Receive a response to a server request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reconnect()">Reconnect</a></strong>()</code>
<div class="block">Reconnect to the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Request_Source_Data(long, long)">Request_Source_Data</a></strong>(long start,
long end)</code>
<div class="block">Get a range of source data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Request(java.lang.String, java.lang.String)">Request</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> method,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request)</code>
<div class="block">Issue a Request preamble to the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reset(long)">Reset</a></strong>(long location)</code>
<div class="block">Reset the buffer to a new source location and empty it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#seek(long)">seek</a></strong>(long location)</code>
<div class="block">Set the current source file location where the next byte will be read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Send(java.lang.String)">Send</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code>
<div class="block">Send a message line to the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Server_Hostname()">Server_Hostname</a></strong>()</code>
<div class="block">Get the source server hostname.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_Pathname()">Source_Pathname</a></strong>()</code>
<div class="block">Get the source pathname.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_Size()">Source_Size</a></strong>()</code>
<div class="block">Get the size of the source file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_URL()">Source_URL</a></strong>()</code>
<div class="block">Get the URL used to access the source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()">Status</a></strong>()</code>
<div class="block">Get the HTTP status of the last response from the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Stream_Location()">Stream_Location</a></strong>()</code>
<div class="block">Get the virtual source location where the next image buffer will be
read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Stream_Location(long)">Stream_Location</a></strong>(long location)</code>
<div class="block">Set the virtual source location where the next image buffer will be
read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Total_Received()">Total_Received</a></strong>()</code>
<div class="block">Get the total number of bytes received from the server so far.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Total_Sent()">Total_Sent</a></strong>()</code>
<div class="block">Get the total number of bytes sent to the server so far.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Usage()">Usage</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/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="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent()">User_Agent</a></strong>()</code>
<div class="block">Get the HTTP user agent name reported to the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)">User_Agent</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Set the HTTP user agent name to be reported to the server.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.imageio.stream.ImageInputStreamImpl">
<!-- -->
</a>
<h3>Methods inherited from class javax.imageio.stream.<a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#checkClosed()" title="class or interface in javax.imageio.stream">checkClosed</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#finalize()" title="class or interface in javax.imageio.stream">finalize</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#flush()" title="class or interface in javax.imageio.stream">flush</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getBitOffset()" title="class or interface in javax.imageio.stream">getBitOffset</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getByteOrder()" title="class or interface in javax.imageio.stream">getByteOrder</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getFlushedPosition()" title="class or interface in javax.imageio.stream">getFlushedPosition</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getStreamPosition()" title="class or interface in javax.imageio.stream">getStreamPosition</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#isCachedFile()" title="class or interface in javax.imageio.stream">isCachedFile</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#mark()" title="class or interface in javax.imageio.stream">mark</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#read(byte[])" title="class or interface in javax.imageio.stream">read</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readBit()" title="class or interface in javax.imageio.stream">readBit</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readBits(int)" title="class or interface in javax.imageio.stream">readBits</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readBoolean()" title="class or interface in javax.imageio.stream">readBoolean</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readByte()" title="class or interface in javax.imageio.stream">readByte</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readBytes(javax.imageio.stream.IIOByteBuffer, int)" title="class or interface in javax.imageio.stream">readBytes</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readChar()" title="class or interface in javax.imageio.stream">readChar</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readDouble()" title="class or interface in javax.imageio.stream">readDouble</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFloat()" title="class or interface in javax.imageio.stream">readFloat</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(byte[])" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(byte[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(char[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(double[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(float[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(int[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(long[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readFully(short[], int, int)" title="class or interface in javax.imageio.stream">readFully</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readInt()" title="class or interface in javax.imageio.stream">readInt</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readLine()" title="class or interface in javax.imageio.stream">readLine</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readLong()" title="class or interface in javax.imageio.stream">readLong</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readShort()" title="class or interface in javax.imageio.stream">readShort</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readUnsignedByte()" title="class or interface in javax.imageio.stream">readUnsignedByte</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readUnsignedInt()" title="class or interface in javax.imageio.stream">readUnsignedInt</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readUnsignedShort()" title="class or interface in javax.imageio.stream">readUnsignedShort</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#readUTF()" title="class or interface in javax.imageio.stream">readUTF</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#reset()" title="class or interface in javax.imageio.stream">reset</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#setBitOffset(int)" title="class or interface in javax.imageio.stream">setBitOffset</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#setByteOrder(java.nio.ByteOrder)" title="class or interface in javax.imageio.stream">setByteOrder</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#skipBytes(int)" title="class or interface in javax.imageio.stream">skipBytes</a>, <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#skipBytes(long)" title="class or interface in javax.imageio.stream">skipBytes</a></code></li>
</ul>
<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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ID</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ID</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="HTTP_VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HTTP_VERSION</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HTTP_VERSION</pre>
<div class="block">The HTTP version identifier used in communication with the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.HTTP_VERSION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ENCODING_SCHEME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENCODING_SCHEME</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENCODING_SCHEME</pre>
<div class="block">The character encoding for messages sent to the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.ENCODING_SCHEME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_USER_AGENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_USER_AGENT</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_USER_AGENT</pre>
<div class="block">The default <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)"><code>User Agent</code></a> reported to the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.DEFAULT_USER_AGENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_PORT</h4>
<pre>public static final int DEFAULT_PORT</pre>
<div class="block">The default port to use for communication with the server.
<p>
The URL used to construct the HTTP_ImageInputStream may specify
a different port to be used.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.DEFAULT_PORT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_CONNECT_TIMEOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONNECT_TIMEOUT</h4>
<pre>public static final int DEFAULT_CONNECT_TIMEOUT</pre>
<div class="block">The amount of time (ms) to wait for a server connection.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.DEFAULT_CONNECT_TIMEOUT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="RECONNECT_WAIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECONNECT_WAIT</h4>
<pre>public static final long RECONNECT_WAIT</pre>
<div class="block">The amount of time (ms) to wait before trying to reconnect with the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.RECONNECT_WAIT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MAX_RECONNECT_ATTEMPTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_RECONNECT_ATTEMPTS</h4>
<pre>public static final int MAX_RECONNECT_ATTEMPTS</pre>
<div class="block">The maximum number of repeated server reconnect tries.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.MAX_RECONNECT_ATTEMPTS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SOURCE_NOT_FOUND_STATUS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SOURCE_NOT_FOUND_STATUS</h4>
<pre>public static final int SOURCE_NOT_FOUND_STATUS</pre>
<div class="block">HTTP <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a> code when the source can not be found
on the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.SOURCE_NOT_FOUND_STATUS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SUCCESS_STATUS_LIMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUCCESS_STATUS_LIMIT</h4>
<pre>public static final int SUCCESS_STATUS_LIMIT</pre>
<div class="block">HTTP <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a> code value below which the request
is deemed successful.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.SUCCESS_STATUS_LIMIT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NO_SOURCE_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_SOURCE_SIZE</h4>
<pre>protected long NO_SOURCE_SIZE</pre>
<div class="block">Source size value if no source has been found.</div>
</li>
</ul>
<a name="Source_Size">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Source_Size</h4>
<pre>protected long Source_Size</pre>
<div class="block">Total size (bytes) of the source data file.
<p>
The value is initialized to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#NO_SOURCE_SIZE"><code>NO_SOURCE_SIZE</code></a> to indicate that
the size is unknown. When HTTP response <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Headers()"><code>headers</code></a>
are received an attempt is made to get the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_Size()"><code>size of the source file</code></a> if it is not already known.</div>
</li>
</ul>
<a name="LOG_OUTPUT_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG_OUTPUT_PREFIX</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LOG_OUTPUT_PREFIX</pre>
<div class="block">When <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging</code></a> is enabled, the prefix to
print before each request message line that is reported sent to the
server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.LOG_OUTPUT_PREFIX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LOG_INPUT_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG_INPUT_PREFIX</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LOG_INPUT_PREFIX</pre>
<div class="block">When <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging</code></a> is enabled, the prefix to
print before each response header line that is reported received
from the server.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.LOG_INPUT_PREFIX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INPUT_INCREMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INPUT_INCREMENT</h4>
<pre>public static final int INPUT_INCREMENT</pre>
<div class="block">The amount of source data to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)"><code>fetch</code></a> when
performing an automatic refresh of buffer contents.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.INPUT_INCREMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_BUFFER_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_BUFFER_SIZE</h4>
<pre>public static final int DEFAULT_BUFFER_SIZE</pre>
<div class="block">The default buffer capacity to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Allocate_Buffer(int)"><code>allocate</code></a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Image_Tools.HTTP_ImageInputStream.DEFAULT_BUFFER_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HTTP_ImageInputStream(java.net.URL)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HTTP_ImageInputStream</h4>
<pre>public HTTP_ImageInputStream(<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/net/UnknownHostException.html?is-external=true" title="class or interface in java.net">UnknownHostException</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">Constructs an HTTP_ImageInputStream on a URL.
<p>
After a successful <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Connect(java.net.URL)"><code>connect</code></a>ion to the server has
been established, a data storage buffer is <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Allocate_Buffer(int)"><code>allocated</code></a> with the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_BUFFER_SIZE"><code>DEFAULT_BUFFER_SIZE</code></a> capacity. Then the
validity of the source is <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Check_Source()"><code>checked</code></a>. If the
source can not be confirmed the connection to the server is closed.
Otherwise, if the server response to the source check contains a
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Content_Length()"><code>content length</code></a> that is used to set the
size of the source file.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - The URL to use to access the source file.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the URL does not specify the
http protocol nor provide a source file pathname.</dd>
<dd><code><a href="/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 of the URL can not
be resolved to an internet address.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - If the source was not found on the server.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/net/ProtocolException.html?is-external=true" title="class or interface in java.net">ProtocolException</a></code> - If an HTTP <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a>
protocol error was returned by the server.</dd>
<dd><code><a href="/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 server connection could not be established.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Source_URL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Source_URL</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> Source_URL()</pre>
<div class="block">Get the URL used to access the source.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The source URL.</dd></dl>
</li>
</ul>
<a name="Server_Hostname()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Server_Hostname</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Server_Hostname()</pre>
<div class="block">Get the source server hostname.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The hostname String for the server.</dd></dl>
</li>
</ul>
<a name="Source_Pathname()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Source_Pathname</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Source_Pathname()</pre>
<div class="block">Get the source pathname.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The pathname String where the source to be found by the server.</dd></dl>
</li>
</ul>
<a name="User_Agent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>User_Agent</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> User_Agent()</pre>
<div class="block">Get the HTTP user agent name reported to the server.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The user agent name String.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)"><code>User_Agent(String)</code></a></dd></dl>
</li>
</ul>
<a name="User_Agent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>User_Agent</h4>
<pre>public <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a> User_Agent(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Set the HTTP user agent name to be reported to the server.
<p>
Every time a request is sent to the server a "User-Agent" message
is included. This information can be used by the server to gather
statistics on it's use by the identified client agent. When an
HTTP_ImageInputStream object is constructed the user agent is
set as the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Default_User_Agent"><code>Default_User_Agent</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The user agent name String. If this is null, the
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Default_User_Agent"><code>Default_User_Agent</code></a> will be assigned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This HTTP_ImageInputStream.</dd></dl>
</li>
</ul>
<a name="Default_User_Agent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Default_User_Agent</h4>
<pre>public static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Default_User_Agent()</pre>
<div class="block">Get the default user agent that will be used with new
HTTP_ImageInputStream objects.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The default user agent String.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)"><code>User_Agent(String)</code></a></dd></dl>
</li>
</ul>
<a name="Default_User_Agent(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Default_User_Agent</h4>
<pre>public static void Default_User_Agent(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Set the default user agent that will be used with new
HTTP_ImageInputStream objects.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The user agent name String. If this is null, the
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_USER_AGENT"><code>DEFAULT_USER_AGENT</code></a> will be assigned.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#User_Agent(java.lang.String)"><code>User_Agent(String)</code></a></dd></dl>
</li>
</ul>
<a name="Total_Sent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Total_Sent</h4>
<pre>public long Total_Sent()</pre>
<div class="block">Get the total number of bytes sent to the server so far.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A long value that is the number of bytes that have been
sent to the server.</dd></dl>
</li>
</ul>
<a name="Total_Received()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Total_Received</h4>
<pre>public long Total_Received()</pre>
<div class="block">Get the total number of bytes received from the server so far.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A long value that is the number of bytes that have been
received from the server.</dd></dl>
</li>
</ul>
<a name="Logging()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Logging</h4>
<pre>public boolean Logging()</pre>
<div class="block">Check if server communication logging is enabled.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if logging is enabled; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Logging(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Logging</h4>
<pre>public <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a> Logging(boolean enabled)</pre>
<div class="block">Enable or disable server communication logging.
<p>
When logging is enabled, each message <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Send(java.lang.String)"><code>sent</code></a> to
the server is printed to stdout preceded by the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#LOG_OUTPUT_PREFIX"><code>LOG_OUTPUT_PREFIX</code></a> String, and each <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Headers()"><code>header</code></a>
response line is printed preceded by the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#LOG_INPUT_PREFIX"><code>LOG_INPUT_PREFIX</code></a>
String. In addition, the amount of data content <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Receive()"><code>receive</code></a>d is printed on a ling after a LOG_INPUT_PREFIX.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - true if logging is to be enabled; false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This HTTP_ImageInputStream.</dd></dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read()
throws <a href="/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">Read a source byte.
<p>
The <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getBitOffset()" title="class or interface in javax.imageio.stream"><code>bit offset</code></a> is set to zero.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#read()" title="class or interface in javax.imageio.stream">read</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#read()" title="class or interface in javax.imageio.stream">read</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The next byte value from the source. This will be -1
if the current source location is end of file.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 access to the source is closed or there was a
problem obtaining source data.</dd></dl>
</li>
</ul>
<a name="read(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(byte[] data,
int offset,
int length)
throws <a href="/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">Read a sequence of source bytes and store them in an array.
<p>
The number of bytes actually read may be less than the specified
length. The length will be reduced to the smaller of the amount
of space in the data array following the offset or the amount of
buffered data remaining after an attempt to provide length bytes.
<p>
The <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getBitOffset()" title="class or interface in javax.imageio.stream"><code>bit offset</code></a> is set to zero.
<p>
The current source input location is advanced by the amount of
data read.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in javax.imageio.stream">read</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#read(byte[], int, int)" title="class or interface in javax.imageio.stream">read</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The byte array into which the data is to be stored.</dd><dd><code>offset</code> - The offset of the array where the first byte read is
to be stored.</dd><dd><code>length</code> - The number of bytes to read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of bytes read and stored. This will be -1 if the
current source location is end of file.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If the data array is null.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - If the offset or length are
negative, or the offset is greater than the length of the data
array.</dd>
<dd><code><a href="/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 access to the source is closed or there was a
problem obtaining source data.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)"><code>Fetch(int)</code></a></dd></dl>
</li>
</ul>
<a name="isCached()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCached</h4>
<pre>public boolean isCached()</pre>
<div class="block">Determine if the source data is cached.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#isCached()" title="class or interface in javax.imageio.stream">isCached</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#isCached()" title="class or interface in javax.imageio.stream">isCached</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true</dd></dl>
</li>
</ul>
<a name="isCachedMemory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCachedMemory</h4>
<pre>public boolean isCachedMemory()</pre>
<div class="block">Determine if the source data is cached in memory.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#isCachedMemory()" title="class or interface in javax.imageio.stream">isCachedMemory</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#isCachedMemory()" title="class or interface in javax.imageio.stream">isCachedMemory</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true</dd></dl>
</li>
</ul>
<a name="length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre>public long length()</pre>
<div class="block">Get the size of the source file.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#length()" title="class or interface in javax.imageio.stream">length</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#length()" title="class or interface in javax.imageio.stream">length</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The size of the source file. This will be -1 if the size
is not yet known. This information may become available after
further interaction with the server providing access to the
source file.</dd></dl>
</li>
</ul>
<a name="flushBefore(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushBefore</h4>
<pre>public void flushBefore(long location)
throws <a href="/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">Discard buffered data before a source location.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#flushBefore(long)" title="class or interface in javax.imageio.stream">flushBefore</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#flushBefore(long)" title="class or interface in javax.imageio.stream">flushBefore</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The source file offset before which buffered
data is to be discarded. If the location is before the beginning
of buffered data nothing is done.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 source file stream is closed.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - If the location is greater than
the current <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getStreamPosition()" title="class or interface in javax.imageio.stream"><code>source input location</code></a>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain(int)"><code>Drain(int)</code></a></dd></dl>
</li>
</ul>
<a name="seek(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seek</h4>
<pre>public void seek(long location)
throws <a href="/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">Set the current source file location where the next byte will be read.
<p>
The <a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#getBitOffset()" title="class or interface in javax.imageio.stream"><code>bit offset</code></a> is set to zero.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#seek(long)" title="class or interface in javax.imageio.stream">seek</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#seek(long)" title="class or interface in javax.imageio.stream">seek</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The source file offset for the image buffer's
next read position. A location less than zero will be set to zero;
a location greater than the source file size will be set to the
end of the source file.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 source file stream is closed or there was
a problem reading data from from the source.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Stream_Location(long)"><code>Stream_Location(long)</code></a></dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="/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">All access to the source is closed.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true#close()" title="class or interface in javax.imageio.stream">close</a></code> in interface <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStream.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStream</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true#close()" title="class or interface in javax.imageio.stream">close</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/javax/imageio/stream/ImageInputStreamImpl.html?is-external=true" title="class or interface in javax.imageio.stream">ImageInputStreamImpl</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 was a problem closing the server
input or output streams or the socket connection.</dd></dl>
</li>
</ul>
<a name="is_Closed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>is_Closed</h4>
<pre>public boolean is_Closed()</pre>
<div class="block">Checks if the server connection is closed.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the server connection is closed; false otherwise.</dd></dl>
</li>
</ul>
<a name="Connect(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Connect</h4>
<pre>public void Connect(<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)
throws <a href="/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">Connect to the server.
<p>
The specified URL checked for validity. If the URL does not specify a
port number, the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_PORT"><code>DEFAULT_PORT</code></a> will be used.
<p>
<b>N.B.</b>: Establishing a new server connection causes any existing
connection to be closed and the source input location to be <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reset(long)"><code>Reset</code></a> to the beginning of the file.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - The URL to use in connection to the server.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the URL does not specify the
http protocol nor provide a source file pathname.</dd>
<dd><code><a href="/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 of the URL can not
be resolved to an internet address.</dd>
<dd><code><a href="/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 connection could not be established
or the input or output streams could not be opened.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reconnect()"><code>Reconnect()</code></a></dd></dl>
</li>
</ul>
<a name="Reconnect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reconnect</h4>
<pre>protected void Reconnect()
throws <a href="/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">Reconnect to the server.
<p>
If a Socket for communication with the server exists it is closed.
<p>
A new Socket connection to the server is constructed. A maximum of
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_CONNECT_TIMEOUT"><code>DEFAULT_CONNECT_TIMEOUT</code></a> milliseconds is allowed for the
connection to be established. Then input and output communication
streams with the server are opened over the Socket. Up to <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#MAX_RECONNECT_ATTEMPTS"><code>MAX_RECONNECT_ATTEMPTS</code></a> connection attempts will be made. On the
last attempt, the first connection operation failure that occurs will
throw an IOException.
<p></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 a Socket could not be constructed on the
server address within the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#DEFAULT_CONNECT_TIMEOUT"><code>DEFAULT_CONNECT_TIMEOUT</code></a> time,
a Writer could not be constructed on the Socket or an InputStream
could not be constructed on the Socket.</dd></dl>
</li>
</ul>
<a name="Allocate_Buffer(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Allocate_Buffer</h4>
<pre>public void Allocate_Buffer(int capacity)</pre>
<div class="block">Allocates a data storage buffer.
<p>
A ByteBuffer of the specified size (bytes) is allocated and cleared
(position set to zero and limit set to the capacity).
<p>
If there is no previously existing source buffer, the newly allocated
buffer is set as the source buffer. It is duplicated to provide the
image buffer view and the image buffer's limit is set to zero.
<p>
If there is a previously existing source buffer, all valid source
data is copied from it into the new buffer, up to the capacity of the
new buffer, and then the new buffer is set as the source buffer.
<b>N.B.</b>: If the new buffer capacity is less than the previous
buffer's valid data content, the excess data will be dropped. The
source buffer is duplicated onto the temporary buffer, the image
buffer limit and position copied over, and then the temporary buffer
is set as the image buffer. <b>N.B.</b>: If the previous image buffer
limit is greater than the new buffer capacity the new limit will be
the new capacity; the same applies to the image buffer position,
which would result in a corresponding move back of the logical stream
location. Garbage collection is initiated to recover the previous
buffer resources.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - The capacity of the new buffer. If less than
twice the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#INPUT_INCREMENT"><code>INPUT_INCREMENT</code></a> it will be increased to this
value.</dd></dl>
</li>
</ul>
<a name="Drain(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Drain</h4>
<pre>public int Drain(int amount)</pre>
<div class="block">Drain data from the buffer.
<p>
The logical location of the buffer in the source data stream is moved
forward by some amount. This has the effect of draining valid source
data from the front of the buffer and sliding the buffer forward
to a new location in the source file.
<p>
If the amount is less than or equal to zero, nothing is done.
<p>
If the amount is greater than or equal to the end of valid source
data in the buffer (image buffer limit), the buffer is simply (@link
#Empty() emptied}.
<p>
The remaining source data beyond the amount buffer index is moved to
the beginning of the buffer. The buffer's logical position is the
source data stream is moved forward by the amount of data removed
(the slide distance). The source buffer input position and image
buffer limit are reset to the new end of valid source data. The image
buffer position is moved back by the amount of of data removed.
However, if this new position would be less than zero it is set to
zero, and the current logical stream location is moved up by the
difference (i.e. to the buffer's logical position in the stream).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - The amount of data to drain.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The amount of source data effectively removed from the buffer
(i.e. the slide distance).</dd></dl>
</li>
</ul>
<a name="Drain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Drain</h4>
<pre>public int Drain()</pre>
<div class="block">Drain source data before the current stream position.
<p>
This has the same effect as <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain(int)"><code>drain</code></a>ing all data
before the current stream (image buffer) position.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The amount of source data effectively removed from the buffer
(i.e. the slide distance).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain(int)"><code>Drain(int)</code></a></dd></dl>
</li>
</ul>
<a name="Empty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Empty</h4>
<pre>public int Empty()</pre>
<div class="block">Empty the buffer of all source data.
<p>
The buffer's logical location in the source data stream is moved up
to the end of source data content in the buffer, and the current
source data stream position is set to this location. The source
buffer position is set to the beginning of the buffer as are the
image buffer position and data limit. This has the same effect as
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain(int)"><code>drain</code></a>ing all the data content from the buffer.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The amount of source data effectively removed from the buffer
(i.e. the slide distance).</dd></dl>
</li>
</ul>
<a name="Reset(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reset</h4>
<pre>public void Reset(long location)</pre>
<div class="block">Reset the buffer to a new source location and empty it.
<p>
<b.N.B.</b>: All buffered source data is dropped regardless of
the location relative to the current buffered source data range.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The new buffer and stream position location.</dd></dl>
</li>
</ul>
<a name="Buffer_Location()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Buffer_Location</h4>
<pre>public long Buffer_Location()</pre>
<div class="block">Get the virtual source location of the beginning of the buffer.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The source file offset where the buffer begins.</dd></dl>
</li>
</ul>
<a name="Buffer_Location(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Buffer_Location</h4>
<pre>protected void Buffer_Location(long location)</pre>
<div class="block">Set the virtual source location of the beginning of the buffer.
<p>
<b>N.B.</b>: Changing the virtual source location of the buffer will
affect all other buffer virtual locations because they are relative
to the buffer location.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The source file offset where the buffer begins.
A value less than zero is set to zero; a value greater than the
size of the source file is set to the size of the source file.</dd></dl>
</li>
</ul>
<a name="Stream_Location()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Stream_Location</h4>
<pre>protected long Stream_Location()</pre>
<div class="block">Get the virtual source location where the next image buffer will be
read.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current image buffer virtual source file offset location.</dd></dl>
</li>
</ul>
<a name="Stream_Location(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Stream_Location</h4>
<pre>public void Stream_Location(long location)
throws <a href="/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">Set the virtual source location where the next image buffer will be
read.
<p>
If the location is within the range of buffered source data the
image buffer position is simply moved to the corresponding position.
<p>
The location is less than zero, zero will be used; if it is greater
than the size of the source file, the location will be set to the
end of the source data.
<p>
If the location is the same as the current virtual source stream
location nothing is done.
<p>
If the location is before the stream location of the first byte in
the image buffer and within <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#INPUT_INCREMENT"><code>INPUT_INCREMENT</code></a> bytes of the
beginning of the buffer, the current buffered data will be shifted
up by INPUT_INCREMENT bytes and the resulting gap at the beginning
of the buffer filled with data <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)"><code>Fetch</code></a>ed from the
corresponding offset range of the source file. The image buffer
position is then set to correspond to the new stream location.
<p>
If the location is beyond the end of buffered data, but not beyond
the end of the maximum capacity of the buffer, and within
INPUT_INCREMENT bytes of the end of data, up to INPUT_INCREMENT
additional bytes (not more than would fill the buffer to capacity)
are <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Fetch(int)"><code>Fetch</code></a>ed from the source file to extend the
buffered data. The image buffer position is then set to correspond
to the new stream location.
<p>
For any other case the buffer is simply <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reset(long)"><code>Reset</code></a>
to the new location.
<p>
The effect is a random access seek to any location within the
source file, with data pre-fetch optimization when the new location
is near the currently buffered data.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The source file offset for the image buffer's
next read position.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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="Data_End_Location()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Data_End_Location</h4>
<pre>public long Data_End_Location()</pre>
<div class="block">Get the virtual source location of the end (exclusive) of buffered
data.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The source file offset where buffered data ends.</dd></dl>
</li>
</ul>
<a name="Data_End_Location(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Data_End_Location</h4>
<pre>protected void Data_End_Location(long location)</pre>
<div class="block">Set the virtual source location of the end (exclusive) of buffered
data.
<p>
<b>N.B.</b>: If the new location is less than the buffer's current
virtual source location, the virtual source location will also be
moved to the new location. This enforces the constraint that the
virtual source location is always less than or equal to the end of
data location.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The source file offset where the end of buffered
data is located. The location is clipped to produce a buffer
position with the range of the buffer capacity.</dd></dl>
</li>
</ul>
<a name="Location_for_Position(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Location_for_Position</h4>
<pre>protected long Location_for_Position(int position)</pre>
<div class="block">Convert a buffer position to a virtual source location.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>position</code> - A buffer position int.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A source location long.</dd></dl>
</li>
</ul>
<a name="Position_for_Location(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Position_for_Location</h4>
<pre>protected int Position_for_Location(long location)</pre>
<div class="block">Convert a virtual source location to a buffer position.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - A source location long.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A buffer position int.</dd></dl>
</li>
</ul>
<a name="Image_Buffer_Range(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Image_Buffer_Range</h4>
<pre>public long Image_Buffer_Range(long location)</pre>
<div class="block">Clip a source location to the currently buffered data range.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - A source location long.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The source location clipped to the range of buffered data.</dd></dl>
</li>
</ul>
<a name="in_Image_Buffer_Range(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>in_Image_Buffer_Range</h4>
<pre>public boolean in_Image_Buffer_Range(long location)</pre>
<div class="block">Test if a source location is in the range of buffered data.
<p>
The buffered data range begins at the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Buffer_Location()"><code>Buffer_Location()</code></a>
(inclusive) and extends to the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Data_End_Location()"><code>Data_End_Location()</code></a> (exclusive).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - A source location long.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the location is the range of buffered data; false
otherwise.</dd></dl>
</li>
</ul>
<a name="Check_Source()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Check_Source</h4>
<pre>public int Check_Source()</pre>
<div class="block">Check the server status of the source.
<p>
A "HEAD" request for the source file is made to the server. The
reponse to a "HEAD" request will contain all the HTTP headers of a
normal request, but no data content will be included.
<p>
If access to the server is closed, then the last HTTP status value
will be returned. If no HTTP status value was ever obtained zero
will be returned. If an end of file condition is encountered will
communicating with the server, -1 will be returned. If some other
IOException is thrown, -2 will be returned. If any other Exception
is thrown, -3 will be returned.
<p>
The HTTP status when the source file is correctly found is less than
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#SUCCESS_STATUS_LIMIT"><code>SUCCESS_STATUS_LIMIT</code></a>. If the source file is not found the
status will be <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#SOURCE_NOT_FOUND_STATUS"><code>SOURCE_NOT_FOUND_STATUS</code></a>.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The HTTP response status.</dd></dl>
</li>
</ul>
<a name="Fetch(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Fetch</h4>
<pre>public int Fetch(long start,
long end)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a>,
<a href="/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">Fetch source data from the server (absolute fetch).
<p>
The data will be fetched from the source file beginning at the start
location up to, but not including, the end location.
<p>
If the start location is within the buffered source data range it is
moved up to the end of data location. If the start location is at or
beyond the end of the source file, nothing is done and zero is
returned. If, after range clipping, the start location is not the
same as the end of source data location in the buffer, the buffer is
is <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reset(long)"><code>reset</code></a> to the start location. The end
location will be clipped to the size of the source file.
<p>
If communication with the server is lost during the data fetch, a
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Reconnect()"><code>reconnect</code></a>ion will be tried. If this succeeds
the data fetch will be repeated.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - The source file offset (inclusive) where the data
fetch is to begin.</dd><dd><code>end</code> - The source file offset (exclusive) where the data
fetch is to end.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The amount of data received from the server.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If start is less than zero or
greater than end.</dd>
<dd><code><a href="/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 was a problem communicating with the
server.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Request_Source_Data(long, long)"><code>Request_Source_Data(long, long)</code></a>,
<a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Receive()"><code>Receive()</code></a></dd></dl>
</li>
</ul>
<a name="Fetch(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Fetch</h4>
<pre>public int Fetch(int amount)
throws <a href="/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">Fetch source data from the server (relative fetch).
<p>
The data will be fetched from the source file starting at the
current end of source data location in the buffer.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - The amount of data to fetch.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The amount of data fetched.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 was a problem send or receiving data
from the server.</dd></dl>
</li>
</ul>
<a name="Request_Source_Data(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Request_Source_Data</h4>
<pre>protected <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream</a> Request_Source_Data(long start,
long end)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/nio/BufferOverflowException.html?is-external=true" title="class or interface in java.nio">BufferOverflowException</a>,
<a href="/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">Get a range of source data.
<p>
<b>N.B.</b>: No check is made of the validity of the source range.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - The file offset of the start of the data range
(inclusive).</dd><dd><code>end</code> - The file offset of the end of the data range
(exclusive).</dd>
<dt><span class="strong">Returns:</span></dt><dd>This HTTP_ImageInputStream.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If start is greater than end.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/nio/BufferOverflowException.html?is-external=true" title="class or interface in java.nio">BufferOverflowException</a></code> - If the (end - start) amount is
greater than Integer.MAX_VALUE.</dd>
<dd><code><a href="/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 was a problem sending the request
to the server.</dd></dl>
</li>
</ul>
<a name="Request(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Request</h4>
<pre>protected void Request(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> method,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request)
throws <a href="/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">Issue a Request preamble to the server.
<p>
After the HTTP formatted request is <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Send(java.lang.String)"><code>sent</code></a> to
the server, the Host, User-Agent, and Cache-Control (no-cache)
requests are also sent. <b>N.B.</b>: The request sequence has not
been <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#End_Request()"><code>ended</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>method</code> - The request method String. This is typically "GET".</dd><dd><code>request</code> - The request operation.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Send(java.lang.String)"><code>Send(String)</code></a></dd></dl>
</li>
</ul>
<a name="End_Request()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>End_Request</h4>
<pre>protected void End_Request()
throws <a href="/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">Send the end-of-request sequence to the server.
<p>
An single empty line is sent.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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="Send(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Send</h4>
<pre>protected void Send(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)
throws <a href="/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">Send a message line to the server.
<p>
The message is expected to be a single line to be sent to the
server. An end of line sequence will be appended to the message that is
sent if it is not already present.
<p>
If <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Logging(boolean)"><code>Logging</code></a> is enabled the message,
preceded by the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#LOG_OUTPUT_PREFIX"><code>LOG_OUTPUT_PREFIX</code></a>, will be printed to
stdout before it is sent to the server.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The message String to be sent.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 connection to the server is closed or
there was a problem sending the message.</dd></dl>
</li>
</ul>
<a name="Receive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Receive</h4>
<pre>protected int Receive()
throws <a href="/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">Receive a response to a server request.
<p>
Server interaction always occurs in <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Request(java.lang.String, java.lang.String)"><code>Request</code></a>-Receive pairs. After a Request has been sent it is necessary
to Receive the response from the server. The first part of the
response is sequence of one or more HTTP header lines. If a
Content-Length line is present the header lines are followed by data
content of Content-Length bytes.
<p>
If the HTTP response headers contain a <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a>
value that is less than 300, the data content is read into the
Source_Buffer starting at its current position. However, if the
amount of free space remaining in the buffer (buffer storage not
occupied by valid data
content; i.e. locations [position, limit), where limit == capacity)
is less than the Content-Length, more buffer space is first provided.
<p>
Space to store data content in the buffer is provided by <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Drain()"><code>drain</code></a>ing away data from the beginning of the buffer
before the current source stream position.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The amount of source data received, or -1 if EOF was
encountered before any data was received.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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="Headers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Headers</h4>
<pre>protected int Headers()
throws <a href="/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">Get the HTTP response headers from the server.
<p>
After a <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Request(java.lang.String, java.lang.String)"><code>Request</code></a> has been sent to the
server - probably followed by <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Send(java.lang.String)"><code>Send</code></a>ing
additional request messages - and <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#End_Request()"><code>End</code></a>ed, the
server response will begin with a sequence of HTTP headers. Each
response line up to, but not including, an empty line will be added
to a Vector of HTTP Headers in which each element is itself a Vector
containing the header name and content. Note: A header line can be
wrapped across multiple response lines; the wrapped line(s) begin
with whitespace. In addition, a header with the same name as a
previous header will have its content appended to previous header.
This guarantees that each header in the Vector of HTTP Headers will
have a unique name.
<p>
Before the header lines are accumulated the HTTP Headers Vector is
cleared and the HTTP response <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Status()"><code>Status</code></a> is reset to
zero. As the header lines are being accumulated the HTTP response
status will be updated if it is found. In addition, the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Source_Size()"><code>source file size</code></a> will also be set if it is found the
response.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The HTTP response status.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/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 an problem was encountered while reading
response lines. This will be an EOFException if an end of
input from the server was encountered.</dd></dl>
</li>
</ul>
<a name="Header_Content(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Header_Content</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Header_Content(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Get the header content for a named header.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of a header.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The content String for the named header, or null if the
header name was not found.</dd></dl>
</li>
</ul>
<a name="Header_Field(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Header_Field</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Header_Field(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Get the complete header field for a named header.
<p>
The header field is provided in the same syntax as it was
received from the server. However, any header wrapping has been
removed. If multiple headers with the same name were received,
a single header field with all content appended in the order it
was received is provided.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of a header.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The complete header field String.</dd></dl>
</li>
</ul>
<a name="Header_Value(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Header_Value</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Header_Value(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value_name)</pre>
<div class="block">Get a header field value by name.
<p>
A header field is divided into value fields by any one of the ':',
';', ',', '&' or whitespace characters. A value field occurs in in
header content as a value name separated from its value by an '='
character.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of a header.</dd><dd><code>value_name</code> - The name of a content value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value String. This will be null if the header or value
name is not found.</dd></dl>
</li>
</ul>
<a name="Header_Value(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Header_Value</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Header_Value(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
int value_index)</pre>
<div class="block">Get a header field value by index within the field content.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of a header.</dd><dd><code>value_index</code> - An index int, starting with zero for the
first value in the content.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value String. This will be null if the header or value
is not found.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Header_Value(java.lang.String, java.lang.String)"><code>Header_Value(String, String)</code></a></dd></dl>
</li>
</ul>
<a name="Status()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Status</h4>
<pre>public int Status()</pre>
<div class="block">Get the HTTP status of the last response from the server.
<p>
The HTTP status is expected to be the second field value of the
"HTTP" response header.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The HTTP status value. This will be zero if no HTTP status
has yet been found. It will be negative if the expected HTTP
status field does not contain an integer value.</dd></dl>
</li>
</ul>
<a name="Source_Size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Source_Size</h4>
<pre>public long Source_Size()</pre>
<div class="block">Get the size of the source file.
<p>
If the source file size has already been determined the cached value
is returned.
<p>
The size of the source file is obtained from the <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#Content_Range()"><code>"Content-Range"</code></a> HTTP response header. If a valid
size value is found the cached value is updated and that value
returned.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The size of the source file. This will be <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.html#NO_SOURCE_SIZE"><code>NO_SOURCE_SIZE</code></a>
if the size is unknown.</dd></dl>
</li>
</ul>
<a name="Content_Length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Content_Length</h4>
<pre>public long Content_Length()</pre>
<div class="block">Get the length of server response data content.
<p>
The length of the data content is expected to be the first field
of the "Content-Length" HTTP response header.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The long value length of the response data content. This
will be -1 if the content length could not be found. It will be
-2 if the expected HTTP header field does not contain an valid
value.</dd></dl>
</li>
</ul>
<a name="Content_Range()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Content_Range</h4>
<pre>public <a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.Range.html" title="class in PIRL.Image_Tools">HTTP_ImageInputStream.Range</a> Content_Range()</pre>
<div class="block">Get the Content-Range header values.
<p>
The format of the Content-Range header is:
<p>
Content-Range: bytes <i>start</i>-<i>end</i>/<i>length</i>
<p>
Where <start> and <end> are byte offsets into the source file
for the start and end (inclusive) of the bytes returned. The
<length> value is the total length of the source file.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A Range containing the Content-Range values, or null
if no Content-Range header could be found. Missing values
in the range are indicated by the value -1.</dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
</li>
</ul>
<a name="Usage()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Usage</h4>
<pre>public static void Usage()</pre>
</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="../../PIRL/Image_Tools/Equirectangular_Projection.html" title="class in PIRL.Image_Tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Image_Tools/HTTP_ImageInputStream.Range.html" title="class in PIRL.Image_Tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Image_Tools/HTTP_ImageInputStream.html" target="_top">Frames</a></li>
<li><a href="HTTP_ImageInputStream.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><a href="#nested_class_summary">Nested</a> | </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>
|