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 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992
|
<Type Name="Socket" FullName="System.Net.Sockets.Socket" FullNameSP="System_Net_Sockets_Socket" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public Socket extends System.Object implements System.IDisposable" />
<TypeSignature Language="C#" Value="public class Socket : IDisposable" />
<MemberOfLibrary>Networking</MemberOfLibrary>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
<AssemblyVersion>1.0.x.x</AssemblyVersion>
<AssemblyCulture>none</AssemblyCulture>
<Attributes>
<Attribute>
<AttributeName>CLSCompliantAttribute(true)</AttributeName>
<Excluded>0</Excluded>
</Attribute>
</Attributes>
</AssemblyInfo>
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
<Docs>
<summary>
<para> Creates a communication endpoint through which an application sends or receives data across a
network.</para>
</summary>
<remarks>
<para> This class enables a <see cref="T:System.Net.Sockets.Socket" /> instance to communicate with another socket
across a network. The communication can
be through connection-oriented and connectionless protocols using either data streams or datagrams
(discrete message packets).</para>
<para>Message-oriented protocols preserve message boundaries
and require that for each <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method call there is one
corresponding <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method call. For stream-oriented protocols, data
is transmitted without regards to message boundaries. In this case, for
example, multiple <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method calls may be necessary to
retrieve all the data from one <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method call. The protocol is set in
the <see langword="Socket" />
class
constructor. </para>
<para>A <see cref="T:System.Net.Sockets.Socket" />
instance has a local and a remote endpoint associated with it. The local
endpoint contains the connection information for the current socket instance.
The remote endpoint contains the connection information for the socket that the current instance communicates with. The
endpoints are required to be an instance of a type derived from
the <see cref="T:System.Net.EndPoint" qualify="true" /> class. For the Transmission Control Protocol (TCP) and User Datagram Protocol (UDP) protocols, an endpoint
includes the address family, an Internet Protocol (IP) address, and a port number.
For connection-oriented protocols (for example, TCP), the remote endpoint
does not have to be specified when transferring data. For connectionless
protocols (for example, UDP), the remote endpoint is required to be specified.</para>
<para>Methods are provided for both synchronous and asynchronous
operations. A synchronous method can operate in blocking mode, in which it waits
(blocks) until the operation is complete before returning, or in non-blocking
mode, where it returns immediately, possibly before the operation has completed.
The blocking mode is set through the <see cref="P:System.Net.Sockets.Socket.Blocking" /> property.</para>
<para> An asynchronous method returns immediately and, by convention, relies on a delegate to
complete the operation. Asynchronous methods have names which correspond to their
synchronous counterparts prefixed with either 'Begin' or End'. For example, the
synchronous <see cref="M:System.Net.Sockets.Socket.Accept" /> method has asynchronous counterpart methods
named <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> and <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" />. The
example for the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method shows the basic
steps for using an asynchronous operation. A complete working example follows this
discussion.</para>
<para>Connection-oriented protocols commonly use the client/server model. In this model, one of
the sockets is set up as a server, and one or more sockets are set
up as clients. A general procedure demonstrating the synchronous communication process for this model is as
follows.</para>
<para>On the server-side:</para>
<list type="number">
<item>
<term>
Create a socket to listen for incoming connection
requests.</term>
</item>
<item>
<term>
Set the local endpoint using the <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)" /> method.</term>
</item>
<item>
<term>
Put the socket in the
listening state using the <see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" /> method.</term>
</item>
<item>
<term>
At this point incoming connection requests from a
client are placed in a queue.</term>
</item>
<item>
<term>
Use the <see cref="M:System.Net.Sockets.Socket.Accept" /> method to create a server socket
for a connection request issued by a client-side socket. This sets the remote
endpoint.</term>
</item>
<item>
<term>
Use the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> methods to communicate with the
client socket.</term>
</item>
<item>
<term>
When communication is finished, terminate the connection
using the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method.</term>
</item>
<item>
<term>
Release the resources allocated by the server socket using
the <see cref="M:System.Net.Sockets.Socket.Close" /> method.</term>
</item>
<item>
<term>
Release the resources allocated by the listener socket using the <see cref="M:System.Net.Sockets.Socket.Close" /> method.</term>
</item>
</list>
<para>On the client-side:</para>
<list type="number">
<item>
<term>
Create the client socket.</term>
</item>
<item>
<term>
Connect to the server socket using the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> method.
This sets both the local and remote endpoints for the client socket.</term>
</item>
<item>
<term>
Use the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> methods to communicate with the
server socket.</term>
</item>
<item>
<term>>
When communication is finished, terminate the connection
using the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method.</term>
</item>
<item>
<term>
Release
the resources allocated by the client socket using
the <see cref="M:System.Net.Sockets.Socket.Close" />
method.</term>
</item>
</list>
<para> The shutdown step in the previous procedure is
not necessary but ensures that any pending data is not lost. If the
<see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method is not called, the
<see cref="M:System.Net.Sockets.Socket.Close" />
method shuts
down the connection either gracefully or by force. A graceful closure attempts
to transfer all pending data before the connection is terminated. Use
the <see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> socket option to specify a graceful closure for a
socket. </para>
<block subset="none" type="note">
<para> This implementation is based on the UNIX sockets implementation
in the Berkeley Software Distribution (BSD, release 4.3)
from the University of California at Berkeley. </para>
</block>
</remarks>
<example>
<para>The following examples provide a client/server
application that demonstrates the
use of asynchronous communication between sockets. Run the client and server on
different consoles.</para>
<para> The following code is for the
server application. Start this application before the client application.</para>
<code lang="C#">using System;
using System.Threading;
using System.Text;
using System.Net;
using System.Net.Sockets;
public class Server
{
// used to pass state information to delegate
internal class StateObject
{
internal byte[] sBuffer;
internal Socket sSocket;
internal StateObject(int size, Socket sock) {
sBuffer = new byte[size];
sSocket = sock;
}
}
static void Main()
{
IPAddress ipAddress =
Dns.Resolve( Dns.GetHostName() ).AddressList[0];
IPEndPoint ipEndpoint =
new IPEndPoint(ipAddress, 1800);
Socket listenSocket =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
listenSocket.Bind(ipEndpoint);
listenSocket.Listen(1);
IAsyncResult asyncAccept = listenSocket.BeginAccept(
new AsyncCallback(Server.acceptCallback),
listenSocket );
// could call listenSocket.EndAccept(asyncAccept) here
// instead of in the callback method, but since
// EndAccept blocks, the behavior would be similar to
// calling the synchronous Accept method
Console.Write("Connection in progress.");
if( writeDot(asyncAccept) == true )
{
// allow time for callbacks to
// finish before the program ends
Thread.Sleep(3000);
}
}
public static void
acceptCallback(IAsyncResult asyncAccept) {
Socket listenSocket = (Socket)asyncAccept.AsyncState;
Socket serverSocket =
listenSocket.EndAccept(asyncAccept);
// arriving here means the operation completed
// (asyncAccept.IsCompleted = true) but not
// necessarily successfully
if( serverSocket.Connected == false )
{
Console.WriteLine( ".server is not connected." );
return;
}
else Console.WriteLine( ".server is connected." );
listenSocket.Close();
StateObject stateObject =
new StateObject(16, serverSocket);
// this call passes the StateObject because it
// needs to pass the buffer as well as the socket
IAsyncResult asyncReceive =
serverSocket.BeginReceive(
stateObject.sBuffer,
0,
stateObject.sBuffer.Length,
SocketFlags.None,
new AsyncCallback(receiveCallback),
stateObject);
Console.Write("Receiving data.");
writeDot(asyncReceive);
}
public static void
receiveCallback(IAsyncResult asyncReceive) {
StateObject stateObject =
(StateObject)asyncReceive.AsyncState;
int bytesReceived =
stateObject.sSocket.EndReceive(asyncReceive);
Console.WriteLine(
".{0} bytes received: {1}",
bytesReceived.ToString(),
Encoding.ASCII.GetString(stateObject.sBuffer) );
byte[] sendBuffer =
Encoding.ASCII.GetBytes("Goodbye");
IAsyncResult asyncSend =
stateObject.sSocket.BeginSend(
sendBuffer,
0,
sendBuffer.Length,
SocketFlags.None,
new AsyncCallback(sendCallback),
stateObject.sSocket);
Console.Write("Sending response.");
writeDot(asyncSend);
}
public static void sendCallback(IAsyncResult asyncSend) {
Socket serverSocket = (Socket)asyncSend.AsyncState;
int bytesSent = serverSocket.EndSend(asyncSend);
Console.WriteLine(
".{0} bytes sent.{1}{1}Shutting down.",
bytesSent.ToString(),
Environment.NewLine );
serverSocket.Shutdown(SocketShutdown.Both);
serverSocket.Close();
}
// times out after 20 seconds but operation continues
internal static bool writeDot(IAsyncResult ar)
{
int i = 0;
while( ar.IsCompleted == false )
{
if( i++ > 40 )
{
Console.WriteLine("Timed out.");
return false;
}
Console.Write(".");
Thread.Sleep(500);
}
return true;
}
}
</code>
<para>The following code is for the client application. When
starting the application, supply the hostname of the console running the server
application as an input parameter (for example, ProgramName <paramref name="hostname" />
). </para>
<code lang="C#">using System;
using System.Threading;
using System.Text;
using System.Net;
using System.Net.Sockets;
public class Client {
// used to pass state information to delegate
class StateObject
{
internal byte[] sBuffer;
internal Socket sSocket;
internal StateObject(int size, Socket sock) {
sBuffer = new byte[size];
sSocket = sock;
}
}
static void Main(string[] argHostName)
{
IPAddress ipAddress =
Dns.Resolve( argHostName[0] ).AddressList[0];
IPEndPoint ipEndpoint =
new IPEndPoint(ipAddress, 1800);
Socket clientSocket = new Socket(
AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
IAsyncResult asyncConnect = clientSocket.BeginConnect(
ipEndpoint,
new AsyncCallback(connectCallback),
clientSocket );
Console.Write("Connection in progress.");
if( writeDot(asyncConnect) == true )
{
// allow time for callbacks to
// finish before the program ends
Thread.Sleep(3000);
}
}
public static void
connectCallback(IAsyncResult asyncConnect) {
Socket clientSocket =
(Socket)asyncConnect.AsyncState;
clientSocket.EndConnect(asyncConnect);
// arriving here means the operation completed
// (asyncConnect.IsCompleted = true) but not
// necessarily successfully
if( clientSocket.Connected == false )
{
Console.WriteLine( ".client is not connected." );
return;
}
else Console.WriteLine( ".client is connected." );
byte[] sendBuffer = Encoding.ASCII.GetBytes("Hello");
IAsyncResult asyncSend = clientSocket.BeginSend(
sendBuffer,
0,
sendBuffer.Length,
SocketFlags.None,
new AsyncCallback(sendCallback),
clientSocket);
Console.Write("Sending data.");
writeDot(asyncSend);
}
public static void sendCallback(IAsyncResult asyncSend)
{
Socket clientSocket = (Socket)asyncSend.AsyncState;
int bytesSent = clientSocket.EndSend(asyncSend);
Console.WriteLine(
".{0} bytes sent.",
bytesSent.ToString() );
StateObject stateObject =
new StateObject(16, clientSocket);
// this call passes the StateObject because it
// needs to pass the buffer as well as the socket
IAsyncResult asyncReceive =
clientSocket.BeginReceive(
stateObject.sBuffer,
0,
stateObject.sBuffer.Length,
SocketFlags.None,
new AsyncCallback(receiveCallback),
stateObject);
Console.Write("Receiving response.");
writeDot(asyncReceive);
}
public static void
receiveCallback(IAsyncResult asyncReceive) {
StateObject stateObject =
(StateObject)asyncReceive.AsyncState;
int bytesReceived =
stateObject.sSocket.EndReceive(asyncReceive);
Console.WriteLine(
".{0} bytes received: {1}{2}{2}Shutting down.",
bytesReceived.ToString(),
Encoding.ASCII.GetString(stateObject.sBuffer),
Environment.NewLine );
stateObject.sSocket.Shutdown(SocketShutdown.Both);
stateObject.sSocket.Close();
}
// times out after 2 seconds but operation continues
internal static bool writeDot(IAsyncResult ar)
{
int i = 0;
while( ar.IsCompleted == false )
{
if( i++ > 20 )
{
Console.WriteLine("Timed out.");
return false;
}
Console.Write(".");
Thread.Sleep(100);
}
return true;
}
}
</code>
<para>The output of the server application is</para>
<c>
<para>Connection in progress...........server is connected.</para>
<para>Receiving data......5 bytes received: Hello</para>
<para>Sending response....7 bytes sent.</para>
<para>Shutting down.</para>
<para>-----------------------------------------</para>
</c>
<para>The output of the client application is</para>
<c>
<para>Connection in progress......client is connected.</para>
<para>Sending data......5 bytes sent.</para>
<para>Receiving response......7 bytes received: Goodbye</para>
<para>Shutting down.</para>
</c>
</example>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
<Excluded>0</Excluded>
</Interface>
</Interfaces>
<Members>
<Member MemberName="System.IDisposable.Dispose">
<MemberSignature Language="ILASM" Value=".method private final hidebysig virtual void System.IDisposable.Dispose()" />
<MemberSignature Language="C#" Value="void IDisposable.Dispose();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implemented to support the <see cref="T:System.IDisposable" /> interface. [Note: For more information, see <see cref="M:System.IDisposable.Dispose" />.]</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="ILASM" Value=".method family hidebysig virtual void Dispose(bool disposing)" />
<MemberSignature Language="C#" Value="protected virtual void Dispose(bool disposing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>
<para>Closes the current instance, releases the unmanaged resources allocated by the current
instance, and optionally releases the
managed resources.</para>
</summary>
<param name="disposing">A <see cref="T:System.Boolean" qualify="true" />. Specify <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<remarks>
<para>
<block subset="none" type="behaviors">
This method
closes the current <see cref="T:System.Net.Sockets.Socket" /> instance
and releases all unmanaged resources allocated by the
current instance. When <paramref name="disposing" /> is <see langword="true" />, this method also releases all resources held by any managed
objects allocated by the current
instance.
</block>
</para>
<para>
<block subset="none" type="default">
This method
closes the current <see cref="T:System.Net.Sockets.Socket" /> instance but does not release any managed
resources.
</block>
</para>
<para>
<block subset="none" type="overrides">
The <see cref="M:System.Net.Sockets.Socket.Dispose(System.Boolean)" /> method can be called
multiple times by other objects. When overriding this method, do not reference
objects that have been previously disposed in an earlier call.
</block>
</para>
<para>
<block subset="none" type="usage">
Use this method to release
resources allocated by
the current
instance.
</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="ILASM" Value=".method family hidebysig virtual void Finalize()" />
<MemberSignature Language="C#" Value="~Socket();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Closes the current instance and releases unmanaged resources allocated by the current
instance.</para>
</summary>
<remarks>
<block subset="none" type="note">
<para> Application code does not call this method; it
is automatically invoked during garbage collection unless finalization by the
garbage collector has been disabled. For more information, see <see cref="M:System.GC.SuppressFinalize(System.Object)" qualify="true" />,
and <see cref="M:System.Object.Finalize" qualify="true" />.</para>
<para> This method calls <see cref="M:System.Net.Sockets.NetworkStream.Dispose(System.Boolean)" />(<see langword="false" />) to free unmanaged
resources used by the current instance.</para>
<para>This method overrides <see cref="M:System.Object.Finalize" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 GetHashCode()" />
<MemberSignature Language="C#" Value="public override int GetHashCode();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Generates a hash code for the current instance.</para>
</summary>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the hash code for the current instance.</para>
</returns>
<remarks>
<para>
The algorithm used to generate the hash code is unspecified.
</para>
<para>
<block subset="none" type="note">
This method overrides <see cref="M:System.Object.GetHashCode" qualify="true" />.
</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Bind">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void Bind(class System.Net.EndPoint localEP)" />
<MemberSignature Language="C#" Value="public void Bind(EndPoint localEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="localEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para>Associates the current instance with a local endpoint.</para>
</summary>
<param name="localEP">
<para>The local <see cref="T:System.Net.EndPoint" qualify="true" /> to be associated with the socket.</para>
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="localEP " />is <see langword="null" />.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<exception cref="T:System.Security.SecurityException"> A caller in the call stack does not have the required permission.</exception>
<remarks>
<para>This method sets the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property of the current instance to
<paramref name="localEP" />.</para>
<block subset="none" type="note">
<para>For connection-oriented protocols, this method is
generally used only on the server-side and is required to be called before the first
call to the <see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" /> method.
On the client-side, binding is usually performed implicitly by the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> method. </para>
<para>For connectionless protocols, the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /><see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />, and <see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" /> methods bind the current instance to
the local endpoint if the current instance has not previously been bound. </para>
</block>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections on the endpoint defined by <paramref name="localEP" />. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void Connect(class System.Net.EndPoint remoteEP)" />
<MemberSignature Language="C#" Value="public void Connect(EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para>Associates the current instance with a remote endpoint.</para>
</summary>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to connect to.</para>
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="remoteEP " />is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<exception cref="T:System.Security.SecurityException"> A caller in the call stack does not have the required permission.</exception>
<remarks>
<para>This method sets the <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property of the current instance to
<paramref name="remoteEP" />.</para>
<block subset="none" type="note">
<para> For connection-oriented protocols, this method
establishes a connection between the current instance and the
socket associated with <paramref name="remoteEP" />. This method is used only on
the client-side. The <see cref="M:System.Net.Sockets.Socket.Accept" /> method establishes the connection on the
server-side. Once the connection has been made, data can
be sent using the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
method, and received using the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method. </para>
<para> For connectionless protocols, the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" />
method can be used from both
client and server-sides, allowing the use of the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method instead of the <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />
method. The <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property is set to
<paramref name="remoteEP" />
and
the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property is set to a value determined
by the protocol; however, a connection is not established. Subsequent data is
required to be received on the endpoint set in
the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property.</para>
</block>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Close">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void Close()" />
<MemberSignature Language="C#" Value="public void Close();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Closes the current instance and releases all managed and unmanaged resources allocated by the current instance.
</para>
</summary>
<remarks>
<para> This method calls the
<see cref="M:System.Net.Sockets.Socket.Dispose(System.Boolean)" />(<see cref="T:System.Boolean" />)
method with the argument set to <see langword="true" />, which frees both managed
and unmanaged resources used by the current instance. </para>
<para>The socket attempts to perform a graceful closure when the <see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> socket option is enabled
and set to a non-zero linger time. In all other cases, closure is forced and any
pending data is lost.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void Shutdown(valuetype System.Net.Sockets.SocketShutdown how)" />
<MemberSignature Language="C#" Value="public void Shutdown(SocketShutdown how);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="how" Type="System.Net.Sockets.SocketShutdown" />
</Parameters>
<Docs>
<summary>
<para> Terminates the ability to send or receive data on a connected socket.</para>
</summary>
<param name="how">One of the values defined in the <see cref="T:System.Net.Sockets.SocketShutdown" /> enumeration.</param>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>When <paramref name="how" /> is set to <see cref="F:System.Net.Sockets.SocketShutdown.Send" /> , the socket on the
other end of the connection is notified that the current instance will not
send any
more data. If the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method is
subsequently called, a <see cref="T:System.Net.Sockets.SocketException" />
exception is thrown.</para>
<para>When <paramref name="how" /> is set to <see cref="F:System.Net.Sockets.SocketShutdown.Receive" />,
the
socket on the other end of the
connection is notified that the current instance will not receive any more
data. After all the data currently queued on the current instance is
received, any subsequent calls to the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> method cause a <see cref="T:System.Net.Sockets.SocketException" /> exception to be thrown.</para>
<para>Setting <paramref name="how" /> to <see cref="F:System.Net.Sockets.SocketShutdown.Both" /> terminates both sends and
receives as described above. Once this occurs, the socket cannot
be used.</para>
<block subset="none" type="note">
<para>To free resources allocated by the current instance, call the <see cref="M:System.Net.Sockets.Socket.Close" />
method.</para>
<para>Expected common usage is for the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" />
method to be called before the <see cref="M:System.Net.Sockets.Socket.Close" /> method to
ensure that all pending data is sent or received.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Listen">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void Listen(int32 backlog)" />
<MemberSignature Language="C#" Value="public void Listen(int backlog);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="backlog" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>Places the current instance into the listening
state where it waits for incoming connection requests.</para>
</summary>
<param name="backlog">A <see cref="T:System.Int32" qualify="true" /> containing the maximum length of the queue of pending connections.</param>
<exception cref="T:System.Net.Sockets.SocketException">The <see cref="P:System.Net.Sockets.Socket.Connected" /> property of the current instance is true, or an error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> Once this method is called, incoming connection requests
are placed in a queue. The maximum size of the queue is specified by the
<paramref name="backlog" /> parameter. The size of the queue is limited to legal
values by the underlying protocol. Illegal values of the <paramref name="backlog" />
parameter are replaced with a legal value, which is implementation defined.</para>
<para>If a connection request arrives and the queue is full, a <see cref="T:System.Net.Sockets.SocketException" /> is thrown on the client.</para>
<para> A socket in the listening state has no
remote endpoint associated with it. Attempting to access the <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property throws a <see cref="T:System.Net.Sockets.SocketException" /> exception.</para>
<para> This method is ignored if called more than once on the
current instance.</para>
<block subset="none" type="note">
<para>This method is used
only on the server-side of connection-oriented protocols. Call the <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)" /> method before
this method is called the first time. Call the <see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" /> method before the first call to the <see cref="M:System.Net.Sockets.Socket.Accept" />
method.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Accept">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.Net.Sockets.Socket Accept()" />
<MemberSignature Language="C#" Value="public Socket Accept();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.Socket</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Creates and initializes a new <see cref="T:System.Net.Sockets.Socket" /> instance and connects it to an incoming connection
request.</para>
</summary>
<returns>
<para> A new connected <see cref="T:System.Net.Sockets.Socket" />
instance.</para>
</returns>
<exception cref="T:System.ArgumentException">An error occurred while creating the new <see cref="T:System.Net.Sockets.Socket" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method is used only on the server-side of connection-oriented protocols. It extracts the first
connection request from the queue of pending requests, creates a new <see cref="T:System.Net.Sockets.Socket" />
instance, and connects this instance to the socket associated with the request.</para>
<para> The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property
of the socket determines the behavior of this method when there are no pending
connection requests. When <see langword="false" />, this method returns
<see langword="null" />.
When <see langword="true" />, this method blocks.</para>
<para> The following properties of the new <see cref="T:System.Net.Sockets.Socket" /> instance returned by this method have values
identical to the corresponding properties of the current instance:</para>
<list type="bullet">
<item>
<term>
<see cref="P:System.Net.Sockets.Socket.AddressFamily" />
</term>
</item>
<item>
<term>
<see cref="P:System.Net.Sockets.Socket.Blocking" />
</term>
</item>
<item>
<term>
<see cref="P:System.Net.Sockets.Socket.LocalEndPoint" />
</term>
</item>
<item>
<term>
<see cref="P:System.Net.Sockets.Socket.ProtocolType" />
</term>
</item>
<item>
<term>
<see cref="P:System.Net.Sockets.Socket.SocketType" />
</term>
</item>
</list>
<para> The <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property of the new instance is set to the local endpoint of the first request in
the input queue. The <see cref="P:System.Net.Sockets.Socket.Connected" /> property is set to <see langword="true" />.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Send">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Send(class System.Byte[] buffer, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Send(byte[] buffer, int size, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para>Sends data to a connected socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="size" /> < 0.</para>
<para> -or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values. </para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0, <paramref name="size" />,
<paramref name="socketFlags" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Send">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Send(class System.Byte[] buffer, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Send(byte[] buffer, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para>Sends data to a connected socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length,
<paramref name="socketFlags" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Send">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Send(class System.Byte[] buffer)" />
<MemberSignature Language="C#" Value="public int Send(byte[] buffer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>
<para> Sends data to a
connected socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0,
<paramref name="buffer" />.Length, <see cref="F:System.Net.Sockets.SocketFlags.None" qualify="true" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Send">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Send(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Send(byte[] buffer, int offset, int size, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para>Sends data to a connected socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="offset">A <see cref="T:System.Int32" qualify="true" /> that specifies the zero-based position in buffer that is the starting location of the data to send.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or- </para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>For connection-oriented protocols, the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property of the current instance is
required to be set before calling this
method.</para>
<para>For connectionless protocols, calling the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> methods sets the <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property and allows the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
method to be used instead of the <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />
method.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" /> flag
is specified as part of the <paramref name="socketFlags" /> parameter,
the sent data is not routed.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> flag is specified as part of the
<paramref name="socketFlags" /> parameter, only out-of-band (OOB) data is sent.</para>
<para>When the <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of the current instance is
set to <see langword="true" /> and
buffer space is not available within the underlying protocol, this method
blocks. </para>
<para>For message-oriented sockets, when the size of
<paramref name="buffer" /> is greater than the maximum message size of the underlying
protocol, no data is sent and the <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 SendTo(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint remoteEP)" />
<MemberSignature Language="C#" Value="public int SendTo(byte[] buffer, int offset, int size, SocketFlags socketFlags, EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para> Sends data to the socket associated with the specified
endpoint.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="offset">A <see cref="T:System.Int32" qualify="true" /> that specifies the zero-based position in buffer that is the starting location of the data to send.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to receive the data.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer or remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or- </para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException"> A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>For connection-oriented protocols and connected sockets using connectionless
protocols, <paramref name="remoteEP" /> overrides the endpoint specified in the <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" /> property.</para>
<para>For unconnected sockets using connectionless protocols, this method sets
the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" />
property of the current instance to a value determined by the protocol.
Subsequent data is required to be received on <see langword="LocalEndPoint" />.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" /> flag
is specified as part of the <paramref name="socketFlags" /> parameter,
the sent data is not routed.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> flag is specified as part of the
<paramref name="socketFlags" /> parameter, only out-of-band (OOB) data is sent.</para>
<para>When the <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of the current instance is
set to <see langword="true" /> and
buffer space is not available within the underlying protocol, this method
blocks. </para>
<para>For message-oriented sockets, when the size of <paramref name="buffer" /> is greater than
the maximum message size of the underlying protocol, no data is sent and the
<see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.</para>
<para>For connection-oriented sockets, the <paramref name="remoteEP" /> property is
ignored.</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 SendTo(class System.Byte[] buffer, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint remoteEP)" />
<MemberSignature Language="C#" Value="public int SendTo(byte[] buffer, int size, SocketFlags socketFlags, EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para> Sends data to the socket associated with the specified
endpoint.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to receive the data.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer or remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="size" /> < 0.</para>
<para> -or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />(<paramref name="buffer" />, 0, <paramref name="size" />,
<paramref name="socketFlags" />, <paramref name="remoteEP" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 SendTo(class System.Byte[] buffer, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint remoteEP)" />
<MemberSignature Language="C#" Value="public int SendTo(byte[] buffer, SocketFlags socketFlags, EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para> Sends data to the socket associated with the specified
endpoint.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />.</param>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to receive the data.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer or remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length,
<paramref name="socketFlags" />, <paramref name="remoteEP" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 SendTo(class System.Byte[] buffer, class System.Net.EndPoint remoteEP)" />
<MemberSignature Language="C#" Value="public int SendTo(byte[] buffer, EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
</Parameters>
<Docs>
<summary>
<para> Sends data to the socket associated with the specified
endpoint.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to send to the socket.</param>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to receive the data.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes sent.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer or remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />(<paramref name="buffer" />,
0, <paramref name="buffer" />.Length, <see cref="F:System.Net.Sockets.SocketFlags.None" qualify="true" />,<paramref name=" remoteEP" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Receive(class System.Byte[] buffer, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Receive(byte[] buffer, int size, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="size" /> < 0.</para>
<para> -or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para> -or- </para>
<para> An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0, <paramref name="size" />,
<paramref name="socketFlags" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Receive(class System.Byte[] buffer, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Receive(byte[] buffer, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a
socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
</exception>
<exception cref="T:System.Security.SecurityException"> A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length,
<paramref name="socketFlags" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections. <block subset="none" type="note">See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</block></permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Receive(class System.Byte[] buffer)" />
<MemberSignature Language="C#" Value="public int Receive(byte[] buffer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException"> A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length,
<see cref="F:System.Net.Sockets.SocketFlags.None" qualify="true" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 Receive(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags)" />
<MemberSignature Language="C#" Value="public int Receive(byte[] buffer, int offset, int size, SocketFlags socketFlags);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer " />to begin storing the received data.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para>-or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property was not set.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>The <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property is required to be set before
this method
is called.</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of the socket determines
the behavior of this method when no incoming data is available. When
<see langword="false" />, the <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown. When
<see langword="true" />, this method blocks and
waits for data
to arrive.</para>
<para> For <see cref="F:System.Net.Sockets.SocketType.Stream" qualify="true" /> socket types, if the remote socket
was shut down gracefully, and all data was received, this method immediately returns zero,
regardless of the blocking state.</para>
<para>For message-oriented sockets, if the message is larger than the size of
<paramref name="buffer" />, the buffer is filled with the first part of the message, and the
<see cref="T:System.Net.Sockets.SocketException" /> exception is thrown. For unreliable
protocols, the excess data is lost; for reliable protocols, the data is retained
by the service provider.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> flag is
specified as part of the <paramref name="socketFlags" /> parameter and the socket is configured for in-line reception of
out-of-band (OOB) data (using the <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" /> socket option) and OOB data is available,
only OOB data is returned.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.Peek" /> flag is specified as part of the
<paramref name="socketFlags" /> parameter, available data is copied into
<paramref name="buffer" /> but is not removed from the system
buffer.</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">
<para>Requires permission to accept a connection on the endpoint defined by the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property of the current instance. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</para>
</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="ReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 ReceiveFrom(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint& remoteEP)" />
<MemberSignature Language="C#" Value="public int ReceiveFrom(byte[] buffer, int offset, int size, SocketFlags socketFlags, ref EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint&" RefType="ref" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket and,
for connectionless protocols, stores the endpoint associated with the socket that sent
the data.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer " />to begin storing the received data.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<param name="remoteEP">A reference to the <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket that sent the data.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer" /> or <paramref name="remoteEP" /> is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para>-or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property was not set.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>For connectionless protocols, when this method successfully completes, <paramref name="remoteEP" /> contains the
endpoint associated with the socket that sent the data.</para>
<para>For connection-oriented protocols, <paramref name="remoteEP" /> is left unchanged.</para>
<para>The <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property is required to be set before
this method is called or a <see cref="T:System.Net.Sockets.SocketException" />
is thrown.</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of the socket determines
the behavior of this method when no incoming data is available. When
<see langword="false" />, the <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown. When
<see langword="true" />, this method blocks and
waits for data to arrive.</para>
<para>For <see cref="F:System.Net.Sockets.SocketType.Stream" qualify="true" /> socket types, if the
remote socket was shut down gracefully, and all data was received, this method
immediately returns zero, regardless of the blocking state.</para>
<para>For message-oriented sockets, if the message is larger than the size of
<paramref name="buffer" />, the buffer is filled with the first part of the message, and the
<see cref="T:System.Net.Sockets.SocketException" />
exception is thrown. For unreliable protocols, the excess data is lost; for
reliable protocols, the data is retained by the service provider.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> flag is specified as part of the<paramref name="socketFlags " />parameter and the socket is configured for
in-line reception of out-of-band (OOB) data (using the <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" /> socket option) and OOB
data is available, only OOB data is returned.</para>
<para>When the <see cref="F:System.Net.Sockets.SocketFlags.Peek" /> flag is specified as part of the
<paramref name="socketFlags" /> parameter, available data is copied into
<paramref name="buffer" />
but is not removed from the system
buffer.</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">
<para>Requires permission to accept a connection on the endpoint defined by the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property of the current instance. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</para>
<para>Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</para>
</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="ReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 ReceiveFrom(class System.Byte[] buffer, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint& remoteEP)" />
<MemberSignature Language="C#" Value="public int ReceiveFrom(byte[] buffer, int size, SocketFlags socketFlags, ref EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint&" RefType="ref" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket and, for connectionless protocols, stores the
endpoint associated with the socket that sent the data.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<param name="remoteEP">A reference to the <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket that sent the data.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer" /> or <paramref name="remoteEP" /> is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="size" /> < 0.</para>
<para> -or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />(<paramref name="buffer" />, 0, <paramref name="size" /> , <paramref name="socketFlags" />, <paramref name="remoteEP" /> ).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections from the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="ReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 ReceiveFrom(class System.Byte[] buffer, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint& remoteEP)" />
<MemberSignature Language="C#" Value="public int ReceiveFrom(byte[] buffer, SocketFlags socketFlags, ref EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint&" RefType="ref" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket and, for connectionless protocols, stores the
endpoint associated with the socket that sent the data.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<param name="remoteEP">A reference to the <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket that sent the data.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer" /> or <paramref name="remoteEP" /> is <see langword="null" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> specified an invalid value.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length, <paramref name="socketFlags" />, <paramref name="remoteEP" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections from the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="ReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 ReceiveFrom(class System.Byte[] buffer, class System.Net.EndPoint& remoteEP)" />
<MemberSignature Language="C#" Value="public int ReceiveFrom(byte[] buffer, ref EndPoint remoteEP);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint&" RefType="ref" />
</Parameters>
<Docs>
<summary>
<para> Receives data from a socket and, for connectionless protocols, stores the
endpoint associated with the socket that sent the data.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name="remoteEP">A reference to the <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket that sent the data.</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" />
containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer" /> or <paramref name="remoteEP" /> is <see langword="null" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">
<para>An asynchronous call is pending and a blocking method has been called.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This method is equivalent to <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />(<paramref name="buffer" />, 0, <paramref name="buffer" />.Length,
<see cref="F:System.Net.Sockets.SocketFlags.None" qualify="true" />, <paramref name="remoteEP" />).</para>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to accept connections from the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="IOControl">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 IOControl(int32 ioControlCode, class System.Byte[] optionInValue, class System.Byte[] optionOutValue)" />
<MemberSignature Language="C#" Value="public int IOControl(int ioControlCode, byte[] optionInValue, byte[] optionOutValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ioControlCode" Type="System.Int32" />
<Parameter Name="optionInValue" Type="System.Byte[]" />
<Parameter Name="optionOutValue" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>
<para> Provides low-level access to the socket, the
transport protocol, or the communications subsystem.</para>
</summary>
<param name="ioControlCode">A <see cref="T:System.Int32" qualify="true" /> containing the control code of the operation to perform.</param>
<param name=" optionInValue">A <see cref="T:System.Byte" qualify="true" /> array containing the input data required by the operation.</param>
<param name=" optionOutValue">A <see cref="T:System.Byte" qualify="true" /> array containing the output data supplied by the operation.</param>
<returns>
<para> A <see cref="T:System.Int32" qualify="true" /> containing the length of the
<paramref name="optionOutValue" /> array after the method returns.</para>
</returns>
<exception cref="T:System.InvalidOperationException">
<para>An attempt was made to change the blocking mode.</para>
<block subset="none" type="note">
<para>Use the <see cref="P:System.Net.Sockets.Socket.Blocking" /> property to change the blocking mode.</para>
</block>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>If an attempt is made to change the blocking mode of the current instance, an
exception is thrown. Use the <see cref="P:System.Net.Sockets.Socket.Blocking" /> property to change the
blocking mode.</para>
<para>
The control codes and their requirements
are implementation defined. Do not use
this method if platform
independence is a requirement.
</para>
<para>
<block subset="none" type="note">
Input data is not required for all control codes. Output data is not supplied
by all control codes and, if not supplied, the return value is 0.
</block>
</para>
</remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission">Requires permission to access unmanaged code. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" qualify="true" />.</permission>
<example>
<para>The following example gets the number of bytes of available
data to be read and writes the result to the console on a Windows system.
The remote endpoint (remoteEndpoint) to connect to may need to be changed to a value that is valid on the current system.</para>
<code lang="C#">using System;
using System.Net;
using System.Net.Sockets;
class App {
static void Main() {
IPAddress remoteAddress =
Dns.Resolve(Dns.GetHostName()).AddressList[0];
IPEndPoint remoteEndpoint =
new IPEndPoint(remoteAddress, 80);
Socket someSocket =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
someSocket.Connect(remoteEndpoint);
int fionRead = 0x4004667F;
byte[]inValue = {0x00, 0x00, 0x00, 0x00};
byte[]outValue = {0x00, 0x00, 0x00, 0x00};
someSocket.IOControl(fionRead, inValue, outValue);
uint bytesAvail = BitConverter.ToUInt32(outValue, 0);
Console.WriteLine(
"There are {0} bytes available to be read.",
bytesAvail.ToString() );
}
}
</code>
<para>The output is</para>
<c>
<para>There are 0 bytes available to be read.</para>
</c>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void SetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName, int32 optionValue)" />
<MemberSignature Language="C#" Value="public void SetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, int optionValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
<Parameter Name="optionValue" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para> Sets socket options with values of type <see cref="T:System.Int32" qualify="true" /> and <see cref="T:System.Boolean" qualify="true" />.</para>
</summary>
<param name="optionLevel">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration. </param>
<param name="optionName">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<param name="optionValue">
<para>A <see cref="T:System.Int32" qualify="true" /> containing the value of the option.</para>
</param>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>Socket options determine the behavior of the current
instance. Multiple options can be set on the current instance by calling
this method multiple times.</para>
<para> For a socket option with a <see cref="T:System.Boolean" />
data type, specify a non-zero
<paramref name="optionValue" /> to enable the option, and an <paramref name="optionValue" /> equal to zero
to disable the option.</para>
<para>Socket options are grouped by level of protocol support.
The following tables list the members of
the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration
supported by each member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration.
Only members that have associated values of the <see cref="T:System.Int32" qualify="true" /> and <see cref="T:System.Boolean" qualify="true" />
data types are listed.</para>
The following table lists the
members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration supported by
the <see langword="Socket" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration.
Options that do not require permission to access unmanaged code are noted.
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description</description>
</listheader>
<item>
<term> Broadcast</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates broadcast messages are allowed to be sent to the socket. </description>
</item>
<item>
<term> Debug</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to record debugging information.</description>
</item>
<item>
<term> DontLinger</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to close the socket without
lingering. This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> DontRoute</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates not to route data.</description>
</item>
<item>
<term> Error</term>
<description>A
<see cref="T:System.Int32" /> that
contains the error code associated with the last socket error. The error
code is cleared by this option. This option is read-only.</description>
</item>
<item>
<term> KeepAlive</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> (the default) indicates to enable
keep-alives, which allows a connection to remain open after a request has completed. This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> OutOfBandInline</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to receive out-of-band data in the normal data stream.</description>
</item>
<item>
<term> ReceiveBuffer</term>
<description>A <see cref="T:System.Int32" /> that specifies the
total per-socket buffer space reserved for receives.
This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> ReceiveTimeout</term>
<description>A
<see cref="T:System.Int32" /> that
specifies the maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" /> methods will block when attempting to
receive data. If data is not received within this
time, a <see cref="T:System.Net.Sockets.SocketException" /> exception
is thrown. This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> ReuseAddress</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> allows the socket to be bound to an address that is already in use.</description>
</item>
<item>
<term> SendBuffer</term>
<description>A <see cref="T:System.Int32" /> that specifies the
total per-socket buffer space reserved for sends. This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> SendTimeout</term>
<description>A
<see cref="T:System.Int32" /> that
specifies the maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" /> methods will block when attempting to
send data. If data is not sent within this time, a <see cref="T:System.Net.Sockets.SocketException" /> exception
is thrown. This option does not require permission to access unmanaged code.</description>
</item>
<item>
<term> Type</term>
<description>
<para>One of the values defined in the <see cref="T:System.Net.Sockets.SocketType" /> enumeration. This option is
read-only.</para>
</description>
</item>
</list><para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" />
enumeration supported by the <see langword="IP" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" />
enumeration. These options require permission to access unmanaged
code.</para><para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description</description>
</listheader>
<item>
<term> HeaderIncluded</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates
the application is providing the IP header for outgoing
datagrams. </description>
</item>
<item>
<term> IPOptions</term>
<description>A <see cref="T:System.Byte" /> array
that specifies IP options to be inserted into outgoing
datagrams.</description>
</item>
<item>
<term> IpTimeToLive</term>
<description>A <see cref="T:System.Int32" /> that specifies the
time-to-live for datagrams. The time-to-live designates the number of
networks on which the datagram is allowed to travel
before being discarded by a
router.</description>
</item>
<item>
<term> MulticastInterface</term>
<description>A
<see cref="T:System.Byte" qualify="true" />
array that specifies the interface for outgoing multicast
packets.</description>
</item>
<item>
<term> MulticastLoopback</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> enables multicast
loopback. </description>
</item>
<item>
<term> MulticastTimeToLive</term>
<description>A <see cref="T:System.Int32" /> that specifies the
time-to-live for multicast datagrams. </description>
</item>
<item>
<term> TypeOfService</term>
<description>A <see cref="T:System.Int32" /> that specifies the
type of service field in the IP header. </description>
</item>
<item>
<term> UseLoopback</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to send a copy of the
data back to the
sender. </description>
</item>
</list>
</para><para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" />
enumeration supported by the <see langword="Tcp" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration.
These options do not require permission to access unmanaged code.</para><para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description</description>
</listheader>
<item>
<term> BsdUrgent</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to use urgent data
as defined by IETF RFC 1222. Once enabled, this option cannot be disabled.</description>
</item>
<item>
<term> Expedited</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to use expedited data as defined by IETF RFC
1222. Once enabled, this option cannot be disabled.</description>
</item>
<item>
<term> NoDelay</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to disable the Nagle algorithm for send
coalescing.</description>
</item>
</list>
</para><para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" />
enumeration supported by the <see langword="Udp" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration.
These options do not require permission to access unmanaged code.</para><para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description</description>
</listheader>
<item>
<term> ChecksumCoverage</term>
<description>A
<see cref="T:System.Boolean" /> that specifies UDP checksum coverage.</description>
</item>
<item>
<term> NoChecksum</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to send UDP datagrams with the checksum set to zero.</description>
</item>
</list>
</para><block subset="none" type="note">
<para>For the
<see langword="AddMembership" />, <see langword="DropMembership" />, and
<see langword="Linger" /> members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration, see
the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" />(<see cref="T:System.Net.Sockets.SocketOptionLevel" />, <see cref="T:System.Net.Sockets.SocketOptionName" />, <see cref="T:System.Object" />) version of this method.</para>
</block></remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission">Some options require permission to access unmanaged code. All the options that do not require permission are noted in the tables in the Description section. All options not so noted require this permission. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void SetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName, class System.Byte[] optionValue)" />
<MemberSignature Language="C#" Value="public void SetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, byte[] optionValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
<Parameter Name="optionValue" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>
<para>Sets socket options with values of type <see langword="Byte[]" />.</para>
</summary>
<param name="optionLevel">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration. </param>
<param name="optionName">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<param name="optionValue">A <see cref="T:System.Byte" qualify="true" /> array containing the value of the option.</param>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>Socket options determine the behavior of the current
instance. Multiple options can be set on the current instance by calling this method
multiple times.</para>
<para>
<block subset="none" type="note">For socket options
with values of type <see cref="T:System.Int32" /> or <see cref="T:System.Boolean" />,
see the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" />(<see cref="T:System.Net.Sockets.SocketOptionLevel" />, <see cref="T:System.Net.Sockets.SocketOptionName" /> , <see cref="T:System.Int32" />) version of this method.</block>
</para>
<para>
<block subset="none" type="note">For the <see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" />, <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" />, or <see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> socket options, see the
<see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" />(<see cref="T:System.Net.Sockets.SocketOptionLevel" />, <see cref="T:System.Net.Sockets.SocketOptionName" />, <see cref="T:System.Object" />) version of this
method.</block>
</para>
</remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission"> Requires permission to access unmanaged code. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void SetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName, object optionValue)" />
<MemberSignature Language="C#" Value="public void SetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, object optionValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
<Parameter Name="optionValue" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Sets the <see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" />, <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" />, or
<see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> socket options.</para>
</summary>
<param name="optionLevel">Either the <see langword="Socket" /> or <see langword="IP" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration.</param>
<param name="optionName">Either the <see langword="Linger" />, <see langword="AddMembership" />, or <see langword="DropMembership" /> member of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<param name="optionValue">An instance of the <see cref="T:System.Net.Sockets.LingerOption" /> or <see cref="T:System.Net.Sockets.MulticastOption" /> class.</param>
<exception cref="T:System.ArgumentException">
<paramref name="optionLevel" />, <paramref name="optionName" />, or <paramref name="optionValue" /> specified an invalid value.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="optionValue" /> is <see langword="null" />.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>Socket options determine the behavior of the current
instance. Multiple options can be set on the current instance by calling this method multiple times.</para>
<para>The following table summarizes the valid combinations of input parameters.</para>
<list type="table">
<listheader>
<term>optionLevel/optionName</term>
<description>optionValue</description>
</listheader>
<item>
<term>
<see langword="Socket" />/<see langword="Linger" /></term>
<description>An instance of the <see cref="T:System.Net.Sockets.LingerOption" qualify="true" /> class.</description>
</item>
<item>
<term>
<para>
<see langword="IP" />/<see langword="AddMembership" /></para>
<para>- or -</para>
<para>
<see langword="IP" />/<see langword="DropMembership" /></para>
</term>
<description>An instance of the <see cref="T:System.Net.Sockets.MulticastOption" qualify="true" /> class.</description>
</item>
</list>
<para> When setting the <see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> option, a <see cref="T:System.ArgumentException" qualify="true" />
exception is thrown if the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property of
the <see cref="T:System.Net.Sockets.LingerOption" /> instance is less than zero or greater
than <see cref="F:System.UInt16.MaxValue" />
. </para>
<block subset="none" type="note">
<para> For more information on the <see cref="F:System.Net.Sockets.SocketOptionName.Linger" /> option,
see the <see cref="T:System.Net.Sockets.LingerOption" /> class and the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" />
method. </para>
<para> For more information on the <see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" /> and <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" /> options, see the <see cref="T:System.Net.Sockets.MulticastOption" /> class. </para>
<para>For socket options
with values of type <see cref="T:System.Int32" /> or <see cref="T:System.Boolean" />, see the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" />(<see cref="T:System.Net.Sockets.SocketOptionLevel" />, <see cref="T:System.Net.Sockets.SocketOptionName" />, <see cref="T:System.Int32" />) version
of this method.</para>
</block>
</remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission">The <see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" /> and <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" /> options require permission to access unmanaged code. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" qualify="true" />.</permission>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="GetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance object GetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName)" />
<MemberSignature Language="C#" Value="public object GetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
</Parameters>
<Docs>
<summary>
<para>Retrieves an object containing the value of the specified socket option.</para>
</summary>
<param name="optionLevel">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration. </param>
<param name="optionName">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<returns>
<para> The following table describes the values returned
by this method.</para>
<list type="table">
<listheader>
<term>optionName</term>
<description>Return value</description>
</listheader>
<item>
<term>
<see langword="Linger" />
</term>
<description> An instance of the <see cref="T:System.Net.Sockets.LingerOption" qualify="true" />
class.</description>
</item>
<item>
<term>
<para>
<see langword="AddMembership" />
</para>
<para> -or-</para>
<para>
<see langword="DropMembership" />
</para>
</term>
<description> An instance of
the <see cref="T:System.Net.Sockets.MulticastOption" qualify="true" />
class.</description>
</item>
<item>
<term> All other values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</term>
<description>A <see cref="T:System.Int32" qualify="true" /> containing the value
of the option.</description>
</item>
</list>
</returns>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>Socket options determine the behavior of the
current instance. </para>
<para>
<paramref name="optionLevel" /> and <paramref name="optionName" /> are not
independent. See the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" />(<see langword="SocketOptionLevel" />,
<see langword="SocketOptionName" />, <see langword="Int32" />) method for a listing of the values of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration grouped
by <see cref="T:System.Net.Sockets.SocketOptionLevel" />. </para>
</remarks>
<example>
<para>The following example gets the state of the linger option and the size of the receive buffer, changes the values of both, then gets the new values.</para>
<code lang="C#">using System;
using System.Net.Sockets;
class OptionTest{
public static void Main() {
// Get the current option values.
Socket someSocket =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
LingerOption lingerOp =
(LingerOption)someSocket.GetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.Linger);
int receiveBuffer =
(int)someSocket.GetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.ReceiveBuffer);
Console.WriteLine(
"Linger option is {0} and set to {1} seconds.",
lingerOp.Enabled.ToString(),
lingerOp.LingerTime.ToString() );
Console.WriteLine(
"Size of the receive buffer is {0} bytes.",
receiveBuffer.ToString() );
// Change the options.
lingerOp = new LingerOption(true, 10);
someSocket.SetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.Linger,
lingerOp);
someSocket.SetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.ReceiveBuffer,
2048);
Console.WriteLine(
"The SetSocketOption method has been called.");
// Get the new option values.
lingerOp =
(LingerOption)someSocket.GetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.Linger);
receiveBuffer =
(int)someSocket.GetSocketOption(
SocketOptionLevel.Socket,
SocketOptionName.ReceiveBuffer);
Console.WriteLine(
"Linger option is now {0} and set to {1} seconds.",
lingerOp.Enabled.ToString(),
lingerOp.LingerTime.ToString());
Console.WriteLine(
"Size of the receive buffer is now {0} bytes.",
receiveBuffer.ToString());
}
}
</code>
<para>The output is</para>
<c>
<para> Linger option is False and set to 0 seconds.</para>
<para> Size of the receive buffer is 8192 bytes.</para>
<para>The SetSocketOption method has been called.</para>
<para> Linger option is now True and set to 10 seconds.</para>
<para> Size of the receive buffer is now 2048 bytes.</para>
</c>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="GetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void GetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName, class System.Byte[] optionValue)" />
<MemberSignature Language="C#" Value="public void GetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, byte[] optionValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
<Parameter Name="optionValue" Type="System.Byte[]" />
</Parameters>
<Docs>
<summary>
<para>Retrieves the value of the specified socket option.</para>
</summary>
<param name="optionLevel">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration. </param>
<param name="optionName">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<param name=" optionValue">A <see cref="T:System.Byte" qualify="true" /> array that receives the value of the specified socket option.</param>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="optionValue" /> is too small to store the value of the specified socket option.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>Socket
options determine the behavior of the current instance.</para>
<para>Upon successful completion, the array specified by the <paramref name="optionValue" /> parameter contains the value of the
specified socket option.</para>
<para>When the length of the <paramref name="optionValue" /> array is smaller than the number of bytes required
to store the value of the specified socket option, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="GetSocketOption">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.Byte[] GetSocketOption(valuetype System.Net.Sockets.SocketOptionLevel optionLevel, valuetype System.Net.Sockets.SocketOptionName optionName, int32 optionLength)" />
<MemberSignature Language="C#" Value="public byte[] GetSocketOption(SocketOptionLevel optionLevel, SocketOptionName optionName, int optionLength);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="optionLevel" Type="System.Net.Sockets.SocketOptionLevel" />
<Parameter Name="optionName" Type="System.Net.Sockets.SocketOptionName" />
<Parameter Name="optionLength" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para> Retrieves the value of the
specified socket option.</para>
</summary>
<param name="optionLevel">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration. </param>
<param name="optionName">One of the values defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration.</param>
<param name=" optionLength">A <see cref="T:System.Int32" qualify="true" /> containing the maximum length, in bytes, of the value of the specified socket option.</param>
<returns>
<para> A <see cref="T:System.Byte" qualify="true" /> array containing the value of the specified socket option.</para>
</returns>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="optionLength" /> is smaller than the number of bytes required to store the value of the specified socket option.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket.</para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> Socket options
determine the behavior of the current instance.</para>
<para>The <paramref name="optionLength" /> parameter
is used to allocate an array to store the value of the specified option. When this value is smaller than the number of bytes required to store
the value of the specified option, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown. When this value is
greater than or equal to the number of bytes required to store the value of the
specified option, the array returned by this
method is allocated to be exactly the required length.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Poll">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance bool Poll(int32 microSeconds, valuetype System.Net.Sockets.SelectMode mode)" />
<MemberSignature Language="C#" Value="public bool Poll(int microSeconds, SelectMode mode);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="microSeconds" Type="System.Int32" />
<Parameter Name="mode" Type="System.Net.Sockets.SelectMode" />
</Parameters>
<Docs>
<summary>
<para>Determines the read, write, or error status of the current instance.</para>
</summary>
<param name="microSeconds">A <see cref="T:System.Int32" qualify="true" /> containing the time to wait for a response, in microseconds. Set the <paramref name="microSeconds" /> parameter to a negative value to wait indefinitely for a response.</param>
<param name=" mode">One of the values defined in the <see cref="T:System.Net.Sockets.SelectMode" /> enumeration.</param>
<returns>
<para>A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates the current instance
satisfies at least one of the conditions in the following table
corresponding to the specified <see cref="T:System.Net.Sockets.SelectMode" />
value; otherwise, <see langword="false" />. <see langword="false" /> is returned if the status of the current instance cannot be determined within the time specified by <paramref name="microSeconds" /> . </para>
<list type="table">
<listheader>
<term>SelectMode value</term>
<description> Condition</description>
</listheader>
<item>
<term> SelectRead</term>
<description>
<para> Data is available for reading (includes
out-of-band data if the <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" /> value defined in
the <see cref="T:System.Net.Sockets.SocketOptionName" />
enumeration
is set).</para>
<para>-or-</para>
<para>The socket is in the listening state with a
pending connection, and
the <see cref="M:System.Net.Sockets.Socket.Accept" /> method has been called and is guaranteed to succeed without
blocking.</para>
<para>-or-</para>
<para> The connection has been closed, reset,
or terminated.</para>
</description>
</item>
<item>
<term> SelectWrite</term>
<description>
<para>Data can be sent.</para>
<para>-or-</para>
<para> A non-blocking <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> method is being processed and the connection has
succeeded.</para>
</description>
</item>
<item>
<term> SelectError</term>
<description>
<para>The <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" /> value defined in
the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration is not set
and out-of-band data is available.</para>
<para>-or-</para>
<para> A non-blocking <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" />
method is being processed and the connection has
failed.</para>
</description>
</item>
</list>
</returns>
<exception cref="T:System.NotSupportedException">
<paramref name="mode " />is not one of the values defined in the <see cref="T:System.Net.Sockets.SelectMode" /> enumeration.</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Select">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void Select(class System.Collections.IList checkRead, class System.Collections.IList checkWrite, class System.Collections.IList checkError, int32 microSeconds)" />
<MemberSignature Language="C#" Value="public static void Select(IList checkRead, IList checkWrite, IList checkError, int microSeconds);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="checkRead" Type="System.Collections.IList" />
<Parameter Name="checkWrite" Type="System.Collections.IList" />
<Parameter Name="checkError" Type="System.Collections.IList" />
<Parameter Name="microSeconds" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>Determines the read, write, or error status of a set
of <see cref="T:System.Net.Sockets.Socket" /> instances.</para>
</summary>
<param name="checkRead">A <see cref="T:System.Collections.IList" /> object containing the <see cref="T:System.Net.Sockets.Socket" /> instances to check for read status.</param>
<param name="checkWrite">A <see cref="T:System.Collections.IList" /> object containing the <see cref="T:System.Net.Sockets.Socket" /> instances to check for write status.</param>
<param name="checkError">A <see cref="T:System.Collections.IList" /> object containing the <see cref="T:System.Net.Sockets.Socket" /> instances to check for error status.</param>
<param name="microSeconds">A <see cref="T:System.Int32" qualify="true" /> that specifies the time to wait for a response, in microseconds. Specify a negative value to wait indefinitely for the status to be determined.</param>
<exception cref="T:System.ArgumentNullException">All of the following parameters are <see langword="null" /> or empty: <paramref name="checkRead" />, <paramref name="checkWrite" />, and <paramref name="checkError" />.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing one of the sockets. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<remarks>
<para>Upon successful completion, this method removes all
<see cref="T:System.Net.Sockets.Socket" /> instances from
the specified list that do not
satisfy one of the conditions associated
with that list. The following table describes the conditions for each list.</para>
<list type="table">
<listheader>
<term>List</term>
<description>Condition to remain in list</description>
</listheader>
<item>
<term>
<paramref name="checkRead" />
</term>
<description>
<para>Data is available for reading (includes
out-of-band data if the <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" />
value defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration is set).</para>
<para>-or-</para>
<para>The socket is in the listening state with a pending connection, and the <see cref="M:System.Net.Sockets.Socket.Accept" /> method has been called
and is guaranteed to succeed without blocking.</para>
<para>-or-</para>
<para>The connection has been closed, reset, or terminated.</para>
</description>
</item>
<item>
<term>
<paramref name="checkWrite" />
</term>
<description>
<para>Data can be sent.</para>
<para>-or-</para>
<para>A non-blocking <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> method is being processed and the
connection has succeeded.</para>
</description>
</item>
<item>
<term>
<paramref name="checkError" />
</term>
<description>
<para>The <see cref="F:System.Net.Sockets.SocketOptionName.OutOfBandInline" />
value defined in the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration is not set and
out-of-band data is available.</para>
<para>-or-</para>
<para>A non-blocking <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> method is being processed and the
connection has failed.</para>
</description>
</item>
</list>
<para>
<block subset="none" type="note">To determine the status of a specific
<see cref="T:System.Net.Sockets.Socket" /> instance, check whether the instance
remains in the list after the method returns.</block>
</para>
<para> When the method cannot determine the status of all the
<see cref="T:System.Net.Sockets.Socket" /> instances within the time specified in the
<paramref name="microseconds" /> parameter, the
method removes all the <see cref="T:System.Net.Sockets.Socket" />
instances from all the lists and returns.</para>
<para> At least one of <paramref name="checkRead" />, <paramref name="checkWrite" />, or
<paramref name="checkError" />, is required to contain at least one <see cref="T:System.Net.Sockets.Socket" /> instance. The
other parameters can be empty or <see langword="null" />.</para>
</remarks>
<example>
<para>The following example determines the status of the socket instance named
socket3 and writes the result to the console.</para>
<code lang="C#">using System;
using System.Collections;
using System.Net.Sockets;
class SelectTest {
public static void Main() {
Socket socket1 =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
Socket socket2 =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
Socket socket3 =
new Socket(AddressFamily.InterNetwork,
SocketType.Stream,
ProtocolType.Tcp);
ArrayList readList = new ArrayList();
ArrayList writeList = new ArrayList();
ArrayList errorList = new ArrayList();
readList.Add(socket1);
readList.Add(socket2);
readList.Add(socket3);
errorList.Add(socket1);
errorList.Add(socket3);
// readList.Contains(Socket3) returns true
// if Socket3 is in ReadList.
Console.WriteLine(
"socket3 is placed in readList and errorList.");
Console.WriteLine(
"socket3 is {0}in readList.",
readList.Contains(socket3) ? "" : "not " );
Console.WriteLine(
"socket3 is {0}in writeList.",
writeList.Contains(socket3) ? "" : "not " );
Console.WriteLine(
"socket3 is {0}in errorList.",
errorList.Contains(socket3) ? "" : "not " );
Socket.Select(readList, writeList, errorList, 10);
Console.WriteLine("The Select method has been called.");
Console.WriteLine(
"socket3 is {0}in readList.",
readList.Contains(socket3) ? "" : "not " );
Console.WriteLine(
"socket3 is {0}in writeList.",
writeList.Contains(socket3) ? "" : "not " );
Console.WriteLine(
"socket3 is {0}in errorList.",
errorList.Contains(socket3) ? "" : "not " );
}
}
</code>
<para>The output is</para>
<c>
<para>socket3 is placed in readList and errorList.</para>
<para>socket3 is in readList.</para>
<para>socket3 is not in writeList.</para>
<para>socket3 is in errorList.</para>
<para>The Select method has been called.</para>
<para>socket3 is not in readList.</para>
<para>socket3 is not in writeList.</para>
<para>socket3 is not in errorList.</para>
</c>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginConnect">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginConnect(class System.Net.EndPoint remoteEP, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginConnect(EndPoint remoteEP, AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to associate the current instance with a remote endpoint.</para>
</summary>
<param name="remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to connect to.</para>
</param>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while starting the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
<remarks>
<para> To release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<para>To determine the connection status, check the <see cref="P:System.Net.Sockets.Socket.Connected" /> property, or use either the <see cref="M:System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode)" />
or <see cref="M:System.Net.Sockets.Socket.Select(System.Collections.IList,System.Collections.IList,System.Collections.IList,System.Int32)" /> method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" />, the
synchronous version of this method.</para>
</block>
</remarks>
<permission cref="T:System.Net.SocketPermission">Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. <block subset="none" type="note">See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</block></permission>
<example>
<para> For an outline of an asynchronous
operation, see the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method, see the
<see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndConnect">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance void EndConnect(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public void EndConnect(IAsyncResult asyncResult);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<summary>
<para> Ends an asynchronous call
to associate the current instance with a remote endpoint.</para>
</summary>
<param name="asyncResult">A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.EndConnect(System.IAsyncResult)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginSend">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginSend(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginSend(byte[] buffer, int offset, int size, SocketFlags socketFlags, AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para>Begins an asynchronous operation to send data to a connected socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array storing data to send to the socket.</param>
<param name=" offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer" /> containing the starting location of the data to send.</param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name=" socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> .</param>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or- </para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>To retrieve the results of the operation and release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by
this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />, the
synchronous version of this method.</para>
</block>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndSend">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 EndSend(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public int EndSend(IAsyncResult asyncResult);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<summary>
<para>Ends an asynchronous call to send data
to a connected socket.</para>
</summary>
<param name="asyncResult">
<para>A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes sent. </para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginSendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginSendTo(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint remoteEP, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginSendTo(byte[] buffer, int offset, int size, SocketFlags socketFlags, EndPoint remoteEP, AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to send data to the socket associated with the specified endpoint.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array storing data to send to the socket.</param>
<param name="offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer" /> to begin sending data.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to send.</param>
<param name="socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.DontRoute" />, or <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" /> .</param>
<param name=" remoteEP">
<para>The <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket to receive the data.</para>
</param>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer " />is <see langword="null" />.</para>
<para>-or-</para>
<para>
<paramref name="remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or-</para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<remarks>
<para>To retrieve the results of the operation and release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />, the
synchronous version of this method.</para>
</block>
</remarks>
<permission cref="T:System.Net.SocketPermission">
<para>Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</para>
</permission>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For
the complete example, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndSendTo">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 EndSendTo(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public int EndSendTo(IAsyncResult asyncResult);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<summary>
<para>Ends an asynchronous call to send data to a socket associated
with a specified endpoint.</para>
</summary>
<param name="asyncResult">
<para>A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</para>
</param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes sent. </para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndSendTo(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For
the complete example, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginReceive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginReceive(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginReceive(byte[] buffer, int offset, int size, SocketFlags socketFlags, AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to receive data from a socket.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name=" offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer " />to begin storing the received data.</param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name=" socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" />.</param>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or-</para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>To retrieve the results of the operation and release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />, the
synchronous version of this method.</para>
</block>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndReceive">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 EndReceive(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public int EndReceive(IAsyncResult asyncResult);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<summary>
<para> Ends an asynchronous call to receive
data from a
socket.</para>
</summary>
<param name="asyncResult">
<para>A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</para>
</param>
<returns>
<para> A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginReceiveFrom(class System.Byte[] buffer, int32 offset, int32 size, valuetype System.Net.Sockets.SocketFlags socketFlags, class System.Net.EndPoint& remoteEP, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginReceiveFrom(byte[] buffer, int offset, int size, SocketFlags socketFlags, ref EndPoint remoteEP, AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="socketFlags" Type="System.Net.Sockets.SocketFlags" />
<Parameter Name="remoteEP" Type="System.Net.EndPoint&" RefType="ref" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to receive data from a socket and,
for connectionless protocols, store the endpoint associated with the socket that
sent the data.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data received from the socket.</param>
<param name=" offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer " />to begin storing the received data.</param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to receive.</param>
<param name=" socketFlags">A bitwise combination of any of the following values defined in the <see cref="T:System.Net.Sockets.SocketFlags" /> enumeration: <see cref="F:System.Net.Sockets.SocketFlags.None" />, <see cref="F:System.Net.Sockets.SocketFlags.OutOfBand" />, or <see cref="F:System.Net.Sockets.SocketFlags.Peek" /> .</param>
<param name=" remoteEP">
<para>An instance of a class derived from the <see cref="T:System.Net.EndPoint" qualify="true" /> class, which contains the endpoint associated with the socket that sent the data.</para>
</param>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="buffer " />is <see langword="null" />.</para>
<para>-or-</para>
<para>
<paramref name="remoteEP " />is <see langword="null" />.</para>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="offset" /> < 0. </para>
<para>-or-</para>
<para>
<paramref name="offset" /> > <paramref name="buffer" />.Length. </para>
<para> -or-</para>
<para>
<paramref name="size" /> < 0.</para>
<para>-or-</para>
<para>
<paramref name="size" /> > <paramref name="buffer" />.Length - <paramref name="offset" />.</para>
</exception>
<exception cref="T:System.Net.Sockets.SocketException">
<para>
<paramref name="socketFlags" /> is not a valid combination of values.</para>
<para>-or-</para>
<para>An error occurred while accessing the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<exception cref="T:System.Security.SecurityException">A caller in the call stack does not have the required permissions.</exception>
<remarks>
<para>To retrieve the results of the operation and release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />, the
synchronous version of this method.</para>
</block>
</remarks>
<permission cref="T:System.Net.SocketPermission">
<para>Requires permission to accept a connection on the endpoint defined by the <see cref="P:System.Net.Sockets.Socket.LocalEndPoint" /> property of the current instance. See <see cref="F:System.Net.NetworkAccess.Accept" qualify="true" />.</para>
<para>Requires permission to make a connection to the endpoint defined by <paramref name="remoteEP" />. See <see cref="F:System.Net.NetworkAccess.Connect" qualify="true" />.</para>
</permission>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, see <see cref="T:System.Net.Sockets.Socket" />.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndReceiveFrom">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance int32 EndReceiveFrom(class System.IAsyncResult asyncResult, class System.Net.EndPoint& endPoint)" />
<MemberSignature Language="C#" Value="public int EndReceiveFrom(IAsyncResult asyncResult, ref EndPoint endPoint);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
<Parameter Name="endPoint" Type="System.Net.EndPoint&" RefType="ref" />
</Parameters>
<Docs>
<summary>
<para>Ends an asynchronous call to receive
data from a socket and store the endpoint associated with the socket that
sent the data.</para>
</summary>
<param name="asyncResult">
<para>A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</para>
</param>
<param name=" endPoint">A reference to the <see cref="T:System.Net.EndPoint" qualify="true" /> associated with the socket that sent the data. </param>
<returns>
<para>A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes received.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndReceiveFrom(System.IAsyncResult,System.Net.EndPoint@)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For
the complete example, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginAccept">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.IAsyncResult BeginAccept(class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public IAsyncResult BeginAccept(AsyncCallback callback, object state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para>Begins an asynchronous operation to accept an incoming connection request.</para>
</summary>
<param name="callback">A <see cref="T:System.AsyncCallback" /> delegate, or <see langword="null" />.</param>
<param name=" state">An application-defined object, or <see langword="null" />.</param>
<returns>
<para>A <see cref="T:System.IAsyncResult" /> instance that contains information about the asynchronous operation.</para>
</returns>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while starting the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>To retrieve the results of the operation and release
resources allocated by the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" /> method, and specify the
<see cref="T:System.IAsyncResult" /> object returned by this
method.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" />
method.</block>
</para>
<para>If the <paramref name="callback" /> parameter is not
<see langword="null" />, the method referenced by <paramref name="callback" /> is invoked
when the asynchronous operation completes. The <see cref="T:System.IAsyncResult" /> object returned by this method is
passed as the argument to the method referenced by <paramref name="callback" />. The method
referenced by <paramref name="callback" /> can retrieve the results of the operation by calling
the <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" />
method.</para>
<para> The <paramref name="state" /> parameter
can be any object that the caller wishes to have available for the duration of
the asynchronous operation. This object is available via the
<see cref="P:System.IAsyncResult.AsyncState" />
property of the object returned by this
method.</para>
<para>To determine the connection status, check the <see cref="P:System.Net.Sockets.Socket.Connected" /> property, or use either the <see cref="M:System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode)" />
or <see cref="M:System.Net.Sockets.Socket.Select(System.Collections.IList,System.Collections.IList,System.Collections.IList,System.Int32)" />
method.</para>
<block subset="none" type="note">
<para>For more information, see <see cref="M:System.Net.Sockets.Socket.Accept" />, the
synchronous version of this method.</para>
</block>
</remarks>
<example>
<para> The following excerpt from the <see cref="T:System.Net.Sockets.Socket" /> class overview
example outlines an asynchronous accept operation. </para>
<code lang="C#">public class Server
{
static void Main()
{
.
.
.
listenSocket.BeginAccept(
new AsyncCallback(Server.acceptCallback),
listenSocket);
.
.
.
// EndAccept can be called here
.
.
.
}
public static void
acceptCallback(IAsyncResult asyncAccept)
{
Socket listenSocket =
(Socket)asyncAccept.AsyncState;
Socket serverSocket =
listenSocket.EndAccept(asyncAccept);
serverSocket.BeginReceive(...);
.
.
.
}
}
</code>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndAccept">
<MemberSignature Language="ILASM" Value=".method public hidebysig instance class System.Net.Sockets.Socket EndAccept(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public Socket EndAccept(IAsyncResult asyncResult);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.Socket</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<summary>
<para> Ends an asynchronous call to accept
an incoming connection
request.</para>
</summary>
<param name="asyncResult">A <see cref="T:System.IAsyncResult" /> object that holds the state information for the asynchronous operation.</param>
<returns>
<para> A new connected <see cref="T:System.Net.Sockets.Socket" />
instance.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult " />is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="asyncResult " /> was not returned by the current instance from a call to the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" /> was previously called for this operation.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred during the operation. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This method blocks if the asynchronous operation has not completed.</para>
<para>The <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method. The object specified for the
<paramref name="asyncResult" /> parameter is required to be the same object as was returned
by the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method, the
<paramref name="asyncResult" /> parameter is the <see cref="T:System.IAsyncResult" />
argument passed to the
delegate's method.</para>
</remarks>
<example>
<para>For an outline of an asynchronous operation, see
the <see cref="M:System.Net.Sockets.Socket.BeginAccept(System.AsyncCallback,System.Object)" /> method.
For the complete example, which uses the <see cref="M:System.Net.Sockets.Socket.EndAccept(System.IAsyncResult)" /> method, see the <see cref="T:System.Net.Sockets.Socket" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(valuetype System.Net.Sockets.AddressFamily addressFamily, valuetype System.Net.Sockets.SocketType socketType, valuetype System.Net.Sockets.ProtocolType protocolType)" />
<MemberSignature Language="C#" Value="public Socket(AddressFamily addressFamily, SocketType socketType, ProtocolType protocolType);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="addressFamily" Type="System.Net.Sockets.AddressFamily" />
<Parameter Name="socketType" Type="System.Net.Sockets.SocketType" />
<Parameter Name="protocolType" Type="System.Net.Sockets.ProtocolType" />
</Parameters>
<Docs>
<summary>
<para> Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.Socket" /> class.
</para>
</summary>
<param name="addressFamily">One of the values defined in the <see cref="T:System.Net.Sockets.AddressFamily" /> enumeration. </param>
<param name="socketType">One of the values defined in the <see cref="T:System.Net.Sockets.SocketType" /> enumeration. </param>
<param name="protocolType">One of the values defined in the <see cref="T:System.Net.Sockets.ProtocolType" /> enumeration. </param>
<exception cref="T:System.Net.Sockets.SocketException">
<para>The combination of <paramref name="addressFamily" />, <paramref name="socketType" />, and <paramref name="protocolType" /> is invalid.</para>
<para>-or-</para>
<para>An error occurred while creating the socket. </para>
<para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para>
</exception>
<remarks>
<para> The <paramref name="addressFamily " />parameter
specifies the addressing scheme used by the current instance, the <paramref name="socketType " />parameter specifies the socket type of the current instance, and the
<paramref name="protocolType" /> parameter
specifies the protocol
used by the current instance. The three parameters are not independent. Some
address families restrict which protocols are used, and often the socket type is
determined by the protocol. When the specified
values are not a valid combination, a <see cref="T:System.Net.Sockets.SocketException" /> exception
is thrown.</para>
<para>Using the <see langword="Unknown" /> member of either the
<see cref="T:System.Net.Sockets.AddressFamily" /> or <see cref="T:System.Net.Sockets.ProtocolType" /> enumeration, results
in a <see cref="T:System.Net.Sockets.SocketException" />
exception being thrown.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Connected">
<MemberSignature Language="ILASM" Value=".property bool Connected { public hidebysig specialname instance bool get_Connected() }" />
<MemberSignature Language="C#" Value="public bool Connected { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets a <see cref="T:System.Boolean" /> value indicating whether the current instance is connected.
</para>
</summary>
<value>
<para>
<see langword="true" /> indicates that
the current instance was connected at
the time of the
last I/O operation;
<see langword="false" /> indicates that the
current instance is not connected.</para>
</value>
<remarks>
<para> This property is read-only.
</para>
<para>When this property returns <see langword="true" />, the current instance was
connected at the time of the last I/O operation; it might not still be connected.
When this property returns <see langword="false" />, the current instance was
never connected or is not currently connected.</para>
<para>The current instance is considered connected when
the <see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" />
property contains a valid endpoint.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.Accept" /> and <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> methods,
and their asynchronous counterparts set this
property.</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="AddressFamily">
<MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.AddressFamily AddressFamily { public hidebysig specialname instance valuetype System.Net.Sockets.AddressFamily get_AddressFamily() }" />
<MemberSignature Language="C#" Value="public AddressFamily AddressFamily { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the address family of the current instance.
</para>
</summary>
<value>
<para>One of the values defined in
the <see cref="T:System.Net.Sockets.AddressFamily" /> enumeration.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>This property is set by the constructor for the current instance. The value of this property specifies the addressing scheme used by the current instance to resolve an address.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SocketType">
<MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.SocketType SocketType { public hidebysig specialname instance valuetype System.Net.Sockets.SocketType get_SocketType() }" />
<MemberSignature Language="C#" Value="public SocketType SocketType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the socket type of the current instance.
</para>
</summary>
<value>
<para>One of the values defined in
the <see cref="T:System.Net.Sockets.SocketType" /> enumeration.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>This property is set by the constructor for the current instance.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="ProtocolType">
<MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.ProtocolType ProtocolType { public hidebysig specialname instance valuetype System.Net.Sockets.ProtocolType get_ProtocolType() }" />
<MemberSignature Language="C#" Value="public ProtocolType ProtocolType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.ProtocolType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the protocol type of the current instance.
</para>
</summary>
<value>
<para>One of the values defined in
the <see cref="T:System.Net.Sockets.ProtocolType" /> enumeration. </para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>This property is set by the constructor for the current instance. The value of
this property specifies the protocol used by the current instance.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Available">
<MemberSignature Language="ILASM" Value=".property int32 Available { public hidebysig specialname instance int32 get_Available() }" />
<MemberSignature Language="C#" Value="public int Available { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the amount
of data available to be read in a single <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> or <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />
call.
</para>
</summary>
<value>
<para> A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes of data that are
available to be read.</para>
</value>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This property is read-only.</para>
<para>When the current instance is stream-oriented (for example, the <see cref="F:System.Net.Sockets.SocketType.Stream" /> socket type), the available data
is generally the total amount of data queued on the current instance.</para>
<para>When the current instance is message-oriented (for example, the <see cref="F:System.Net.Sockets.SocketType.Dgram" /> socket type), the available data
is the first message in the input queue.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="LocalEndPoint">
<MemberSignature Language="ILASM" Value=".property class System.Net.EndPoint LocalEndPoint { public hidebysig specialname instance class System.Net.EndPoint get_LocalEndPoint() }" />
<MemberSignature Language="C#" Value="public EndPoint LocalEndPoint { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.EndPoint</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the local endpoint associated with the current instance.
</para>
</summary>
<value>
<para> The local <see cref="T:System.Net.EndPoint" qualify="true" />
associated with the current
instance.</para>
</value>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This property is read-only. </para>
<para>This property contains the network connection information for the
current instance. </para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)" /> and
<see cref="M:System.Net.Sockets.Socket.Accept" /> methods,
and their
asynchronous counterparts set this property. If not previously set,
the <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> and <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" /> methods, and their asynchronous counterparts set this property.
</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="RemoteEndPoint">
<MemberSignature Language="ILASM" Value=".property class System.Net.EndPoint RemoteEndPoint { public hidebysig specialname instance class System.Net.EndPoint get_RemoteEndPoint() }" />
<MemberSignature Language="C#" Value="public EndPoint RemoteEndPoint { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.EndPoint</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the remote endpoint associated with the current instance.
</para>
</summary>
<value>
<para> The remote <see cref="T:System.Net.EndPoint" qualify="true" />
associated with the current instance.</para>
</value>
<exception cref="T:System.Net.Sockets.SocketException">An error occurred while accessing the socket. <para>
<block subset="none" type="note">For additional information on causes of the <see langword=" SocketException" />, see the <see cref="T:System.Net.Sockets.SocketException" qualify="true" /> class.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> This property
is read-only.</para>
<para> This property contains the network
connection information associated with the socket communicating with the current
instance.</para>
<para> There is no remote endpoint
associated with a socket in the listening state. An attempt to access the
<see cref="P:System.Net.Sockets.Socket.RemoteEndPoint" />
property causes a <see cref="T:System.Net.Sockets.SocketException" /> exception to be
thrown.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.Sockets.Socket.Accept" /> and <see cref="M:System.Net.Sockets.Socket.Connect(System.Net.EndPoint)" /> methods, and their asynchronous
counterparts set this property. </block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="ILASM" Value=".property valuetype System.IntPtr Handle { public hidebysig specialname instance valuetype System.IntPtr get_Handle() }" />
<MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the operating system handle for the current instance.
</para>
</summary>
<value>
<para>A <see cref="T:System.IntPtr" qualify="true" /> containing the operating system handle for the current instance.</para>
</value>
<remarks>
<para>This property is read-only.</para>
</remarks>
<permission cref="T:System.Security.Permissions.SecurityPermission"> Requires permission to access unmanaged code. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" qualify="true" />.</permission>
</Docs>
<Excluded>1</Excluded>
<ExcludedLibrary>RuntimeInfrastructure</ExcludedLibrary>
</Member>
<Member MemberName="Blocking">
<MemberSignature Language="ILASM" Value=".property bool Blocking { public hidebysig specialname instance bool get_Blocking() public hidebysig specialname instance void set_Blocking(bool value) }" />
<MemberSignature Language="C#" Value="public bool Blocking { get; set; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets or sets a <see cref="T:System.Boolean" qualify="true" /> value that indicates whether the socket is in blocking mode.
</para>
</summary>
<value>
<para>
<see langword="true" /> indicates that
the current instance is in blocking mode;
<see langword="false" /> indicates that the current instance is in
non-blocking mode. </para>
</value>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> Blocking is when a method waits to complete an operation before returning. Sockets are created in blocking mode
by default. </para>
<para> Except for when the current instance has been disposed, no notification is given when an attempt to change
the value of this property fails.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SupportsIPv4">
<MemberSignature Language="C#" Value="public static bool SupportsIPv4 { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SupportsIPv6">
<MemberSignature Language="C#" Value="public static bool SupportsIPv6 { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|