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
|
<Type Name="NetworkStream" FullName="System.Net.Sockets.NetworkStream" FullNameSP="System_Net_Sockets_NetworkStream" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public NetworkStream extends System.IO.Stream" />
<TypeSignature Language="C#" Value="public class NetworkStream : Stream" />
<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> Implements the standard stream mechanism to read
and write network data through an instance of the <see cref="T:System.Net.Sockets.Socket" /> class.
</para>
</summary>
<remarks>
<para>The <see cref="T:System.Net.Sockets.NetworkStream" /> class allows network data to be read and written
in the same manner as the <see cref="T:System.IO.Stream" qualify="true" />
class.</para>
<para> This class supports simultaneous synchronous and asynchronous access
to the network data. Random access is not supported and thus
the <see cref="P:System.Net.Sockets.NetworkStream.CanSeek" />
property always returns
<see langword="false." /></para>
<para> The following properties and methods inherited from the <see cref="T:System.IO.Stream" qualify="true" /> class are
not supported and throw a <see cref="T:System.NotSupportedException" />
exception when
accessed:</para>
<list type="bullet">
<item>
<term>
<see cref="P:System.Net.Sockets.NetworkStream.Length" />
</term>
</item>
<item>
<term>
<see cref="P:System.Net.Sockets.NetworkStream.Position" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.NetworkStream.Seek(System.Int64,System.IO.SeekOrigin)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.NetworkStream.SetLength(System.Int64)" />
</term>
</item>
</list>
<para>The <see cref="M:System.Net.Sockets.NetworkStream.Flush" /> method is reserved for future use but does not throw an exception.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.IO.Stream</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
<Excluded>0</Excluded>
</Interface>
</Interfaces>
<Members>
<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>Releases the unmanaged resources used 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; specify <see langword="false" /> to release only unmanaged resources.</param>
<remarks>
<block subset="none" type="note">
<para> Ownership of a socket is specified using the <see cref="T:System.Net.Sockets.NetworkStream" />
constructor.</para>
<para> The
<see cref="M:System.Net.Sockets.NetworkStream.Close" /> method calls this method with
the <paramref name="disposing" /> parameter set to <see langword="true" />. The finalizer
calls this method with the <paramref name="disposing" /> parameter set to <see langword="false" />.</para>
</block>
<para>
<block subset="none" type="behaviors">
This method
closes the current <see cref="T:System.Net.Sockets.NetworkStream" />
instance releasing all unmanaged resources allocated by the current instance.
When the underlying socket is owned by the current
instance, the <see cref="M:System.Net.Sockets.Socket.Close" qualify="true" /> method of
the socket is called, which frees
the managed and unmanaged resources used by the
socket. When the <paramref name="disposing" /> parameter is <see langword="true" /> , this method also releases all resources held by any other
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.NetworkStream" />
instance releasing all unmanaged resources allocated by the current instance.
When the underlying socket is owned by the current
instance, the <see cref="M:System.Net.Sockets.Socket.Close" qualify="true" /> method of
the socket is called, which frees the managed and unmanaged resources used by the
socket.
</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="Write">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Write(class System.Byte[] buffer, int32 offset, int32 size)" />
<MemberSignature Language="C#" Value="public override void Write(byte[] buffer, int offset, int size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>Writes data from a specific area of a data buffer to the current instance.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to write to the stream.</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 write.</param>
<param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to write to the stream.</param>
<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.IO.IOException">An error occurred while accessing the underlying socket. <para>
<block subset="none" type="note">This method catches all exceptions thrown by the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" qualify="true" /> method.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>When no buffer space is available within the underlying protocol, this method
blocks unless the socket is in non-blocking mode. </para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.IO.Stream.Write(System.Byte[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Read">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 Read(class System.Byte[] buffer, int32 offset, int32 size)" />
<MemberSignature Language="C#" Value="public override int Read(byte[] buffer, int offset, int size);" />
<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" />
</Parameters>
<Docs>
<summary>
<para> Reads data from the current instance and stores it in a data buffer.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data read from the stream. </param>
<param name=" offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer" /> at which to begin storing the data. </param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to read. </param>
<returns>
<para> A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes read from the
stream.
</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.IO.IOException">An error occurred while accessing the underlying socket. <para>
<block subset="none" type="note">This method catches all exceptions thrown by the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" qualify="true" /> method.</block>
</para></exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> When no incoming data is available, this method blocks and
waits for data to arrive.</para>
<para> If the remote socket was shut down gracefully (<see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" qualify="true" /> was called on the socket or
the <see cref="F:System.Net.Sockets.SocketOptionName.Linger" qualify="true" /> option was enabled
and <see cref="M:System.Net.Sockets.Socket.Close" qualify="true" /> was called on the socket) and all data was received, this
method immediately returns zero.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.IO.Stream.Read(System.Byte[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SetLength">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void SetLength(int64 value)" />
<MemberSignature Language="C#" Value="public override void SetLength(long value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<summary>
<para>Throws a <see cref="T:System.NotSupportedException" />.</para>
</summary>
<param name="value">This parameter is not used.</param>
<exception cref="T:System.NotSupportedException">Any call to this method.</exception>
<remarks>
<block subset="none" type="note">
<para>The <see cref="T:System.IO.Stream" />
base class uses this method to set the length of the data available on the
stream. This functionality is not supported in the <see cref="T:System.Net.Sockets.NetworkStream" /> class.</para>
<para>This method overrides <see cref="M:System.IO.Stream.SetLength(System.Int64)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Seek">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual int64 Seek(int64 offset, valuetype System.IO.SeekOrigin origin)" />
<MemberSignature Language="C#" Value="public override long Seek(long offset, SeekOrigin origin);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="origin" Type="System.IO.SeekOrigin" />
</Parameters>
<Docs>
<summary>
<para> Throws a <see cref="T:System.NotSupportedException" />.</para>
</summary>
<param name="offset">This parameter is not used.</param>
<param name=" origin">This parameter is not used.</param>
<exception cref="T:System.NotSupportedException">Any call to this method.</exception>
<remarks>
<block subset="none" type="note">
<para> The <see cref="T:System.IO.Stream" /> base class uses this method to set the current
position in the stream. This functionality is not supported in the <see cref="T:System.Net.Sockets.NetworkStream" />
class.</para>
<para>This method overrides <see cref="M:System.IO.Stream.Seek(System.Int64,System.IO.SeekOrigin)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndWrite">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void EndWrite(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public override void EndWrite(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 write data to the current instance.</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.IO.IOException">An error occurred while accessing the underlying socket. <para>
<block subset="none" type="note">This method catches all exceptions thrown by the <see cref="M:System.Net.Sockets.Socket.EndSend(System.IAsyncResult)" qualify="true" /> method.</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.NetworkStream.EndWrite(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,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.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.NetworkStream.EndWrite(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,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>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" qualify="true" />.</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)" qualify="true" /> method.
For the complete example, see the <see cref="T:System.Net.Sockets.Socket" qualify="true" /> class
overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginWrite">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.IAsyncResult BeginWrite(class System.Byte[] buffer, int32 offset, int32 size, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public override IAsyncResult BeginWrite(byte[] buffer, int offset, int size, 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="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to write data to the current instance.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing data to write to the stream. </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 write. </param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to write to the stream. </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.IO.IOException">
<para>An error occurred while accessing the underlying socket. </para>
<para>
<block subset="none" type="note">Any exception thrown by the <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" qualify="true" /> method is caught and rethrown as an <see langword="IOException" /> with the original exception stored in the <see cref="P:System.Exception.InnerException" /> property.</block>
</para>
</exception>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para> To release
resources allocated by the <see cref="M:System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.NetworkStream.EndWrite(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.NetworkStream.EndWrite(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.NetworkStream.BeginWrite(System.Byte[],System.Int32,System.Int32,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.NetworkStream.EndWrite(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>This method overrides <see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" qualify="true" />.</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)" qualify="true" />
method. For the complete example, see the <see cref="T:System.Net.Sockets.Socket" qualify="true" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="EndRead">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 EndRead(class System.IAsyncResult asyncResult)" />
<MemberSignature Language="C#" Value="public override int EndRead(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
read data from the current instance.</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 <see cref="T:System.Int32" qualify="true" /> containing the number of bytes read from the stream.
</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="asyncResult" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.IOException">An error occurred while accessing the underlying socket. <para>
<block subset="none" type="note">This method catches all exceptions thrown by the <see cref="M:System.Net.Sockets.Socket.EndReceive(System.IAsyncResult)" qualify="true" /> method.</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.NetworkStream.EndRead(System.IAsyncResult)" />
method completes an asynchronous request that was started with a call to the
<see cref="M:System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,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.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />
method call that began the
request.</para>
<para>If the <see cref="M:System.Net.Sockets.NetworkStream.EndRead(System.IAsyncResult)" />
method is invoked via the <see cref="T:System.AsyncCallback" /> delegate specified to the <see cref="M:System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,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>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" qualify="true" />.</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)" qualify="true" /> method.
For the complete example, see the <see cref="T:System.Net.Sockets.Socket" qualify="true" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BeginRead">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.IAsyncResult BeginRead(class System.Byte[] buffer, int32 offset, int32 size, class System.AsyncCallback callback, object state)" />
<MemberSignature Language="C#" Value="public override IAsyncResult BeginRead(byte[] buffer, int offset, int size, 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="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<summary>
<para> Begins an asynchronous operation to read data from the current instance.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array to store data read from the stream. </param>
<param name=" offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based position in <paramref name="buffer" /> at which to begin storing the data. </param>
<param name=" size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to read. </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.IO.IOException">
<para>An error occurred while accessing the underlying socket.</para>
<para>
<block subset="none" type="note">Any exception thrown by the <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" qualify="true" /> method is caught and rethrown as an <see langword="IOException" /> with the original exception stored in the <see cref="P:System.Exception.InnerException" /> property.</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.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> method, call
the <see cref="M:System.Net.Sockets.NetworkStream.EndRead(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.NetworkStream.EndRead(System.IAsyncResult)" /> method should be
called exactly once for each call to the <see cref="M:System.Net.Sockets.NetworkStream.BeginRead(System.Byte[],System.Int32,System.Int32,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.NetworkStream.EndRead(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>This method overrides <see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" qualify="true" />.</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)" qualify="true" /> method. For the complete example, see
the <see cref="T:System.Net.Sockets.Socket" qualify="true" /> class overview.</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Flush()" />
<MemberSignature Language="C#" Value="public override void Flush();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> This method is reserved for future use.
</para>
</summary>
<remarks>
<para>Calling this method does not throw an exception.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.IO.Stream.Flush" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Close">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Close()" />
<MemberSignature Language="C#" Value="public override void Close();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Closes the stream and, if owned by the current instance, the underlying socket.
</para>
</summary>
<remarks>
<para> This method calls <see cref="M:System.Net.Sockets.NetworkStream.Dispose(System.Boolean)" />(<see langword="true" /> ), which frees both managed and unmanaged
resources used by the current instance. When the underlying socket is owned by
the current instance, the <see cref="M:System.Net.Sockets.Socket.Close" />
method of the socket is called, which frees both managed and unmanaged resources
used by the socket.</para>
<block subset="none" type="note">
<para> Ownership of a socket is
specified using the <see cref="T:System.Net.Sockets.NetworkStream" /> constructor.</para>
<para>This method overrides <see cref="M:System.IO.Stream.Close" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="ILASM" Value=".method family hidebysig virtual void Finalize()" />
<MemberSignature Language="C#" Value="~NetworkStream();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Frees unmanaged resources used 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" />), which frees unmanaged resources used by
the current instance. When the underlying socket is owned by the current
instance, it is closed and the managed and unmanaged resources used by the
socket are freed.</para>
<para>Ownership of a socket is specified using the <see cref="T:System.Net.Sockets.NetworkStream" /> constructor.</para>
<para>This method overrides <see cref="M:System.Object.Finalize" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.Sockets.Socket socket)" />
<MemberSignature Language="C#" Value="public NetworkStream(Socket socket);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="socket" Type="System.Net.Sockets.Socket" />
</Parameters>
<Docs>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" />
class.</para>
</summary>
<param name="socket">An instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.IOException">
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Connected" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of <paramref name="socket" /> is not <see cref="F:System.Net.Sockets.SocketType.Stream" />.</para>
</exception>
<remarks>
<para>This constructor is equivalent to
<see cref="!:System.Net.Sockets.NetworkStream.NetworkStream" />(<paramref name="socket" />, <see cref="F:System.IO.FileAccess.ReadWrite" qualify="true" />, <see langword="false" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.Sockets.Socket socket, bool ownsSocket)" />
<MemberSignature Language="C#" Value="public NetworkStream(Socket socket, bool ownsSocket);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="socket" Type="System.Net.Sockets.Socket" />
<Parameter Name="ownsSocket" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class.</para>
</summary>
<param name="socket">An instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</param>
<param name=" ownsSocket">
<see langword="true" /> if <paramref name="socket" /> is owned by the current instance; otherwise, <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.IOException">
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Connected" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of <paramref name="socket" /> is not <see cref="F:System.Net.Sockets.SocketType.Stream" />.</para>
</exception>
<remarks>
<para>This constructor is
equivalent to <see cref="!:System.Net.Sockets.NetworkStream.NetworkStream" />(<paramref name="socket" />, <see cref="F:System.IO.FileAccess.ReadWrite" qualify="true" />,
<paramref name="ownsSocket" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.Sockets.Socket socket, valuetype System.IO.FileAccess access)" />
<MemberSignature Language="C#" Value="public NetworkStream(Socket socket, FileAccess access);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="socket" Type="System.Net.Sockets.Socket" />
<Parameter Name="access" Type="System.IO.FileAccess" />
</Parameters>
<Docs>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" />
class.</para>
</summary>
<param name="socket">An instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</param>
<param name=" access">One of the values of the <see cref="T:System.IO.FileAccess" qualify="true" /> enumeration.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.IOException">
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Connected" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of <paramref name="socket" /> is not <see cref="F:System.Net.Sockets.SocketType.Stream" />.</para>
</exception>
<remarks>
<para>This constructor is equivalent to
<see cref="!:System.Net.Sockets.NetworkStream.NetworkStream" />(<paramref name="socket" />, <paramref name="access" />, <see langword="false" />).</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.Sockets.Socket socket, valuetype System.IO.FileAccess access, bool ownsSocket)" />
<MemberSignature Language="C#" Value="public NetworkStream(Socket socket, FileAccess access, bool ownsSocket);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="socket" Type="System.Net.Sockets.Socket" />
<Parameter Name="access" Type="System.IO.FileAccess" />
<Parameter Name="ownsSocket" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class.</para>
</summary>
<param name="socket">An instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</param>
<param name="access">One of the values of the <see cref="T:System.IO.FileAccess" qualify="true" /> enumeration.</param>
<param name=" ownsSocket">
<see langword="true" /> if <paramref name="socket" /> is owned by the current instance; otherwise, <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.IOException">
<para>The <see cref="P:System.Net.Sockets.Socket.Blocking" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.Connected" /> property of <paramref name="socket" /> is <see langword="false" />.</para>
<para> -or-</para>
<para>The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of <paramref name="socket" /> is not <see cref="F:System.Net.Sockets.SocketType.Stream" />.</para>
</exception>
<remarks>
<para>
<paramref name="socket" /> is required to be an
instance of the <see cref="T:System.Net.Sockets.Socket" /> class with its <see cref="P:System.Net.Sockets.Socket.Connected" />
property equal to <see langword="true" />
, <see cref="P:System.Net.Sockets.Socket.Blocking" /> property equal to <see langword="true" /> ,
and <see cref="T:System.Net.Sockets.SocketType" /> equal to <see cref="F:System.Net.Sockets.SocketType.Stream" />.</para>
<para> When <paramref name="ownsSocket" /> is <see langword="true" />, the current instance owns <paramref name="socket" />, meaning the <see cref="M:System.Net.Sockets.NetworkStream.Close" />
and <see cref="M:System.Net.Sockets.NetworkStream.Dispose(System.Boolean)" /> methods call the <see cref="M:System.Net.Sockets.Socket.Close" />
method of <paramref name="socket" />.</para>
<para>The <see cref="P:System.Net.Sockets.NetworkStream.Readable" /> and <see cref="P:System.Net.Sockets.NetworkStream.Writeable" /> properties are set depending on the value of
<paramref name="access" />. If <paramref name="access" /> is
not one of the values defined in the <see cref="T:System.IO.FileAccess" /> enumeration, the <see cref="P:System.Net.Sockets.NetworkStream.Readable" /> and <see cref="P:System.Net.Sockets.NetworkStream.Writeable" /> properties are set to
<see langword="true" />.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="CanRead">
<MemberSignature Language="ILASM" Value=".property bool CanRead { public hidebysig virtual specialname bool get_CanRead() }" />
<MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets a <see cref="T:System.Boolean" qualify="true" /> value indicating whether the current stream supports reading.
</para>
</summary>
<value>
<para>
<see langword="true" /> indicates that the current stream supports reading;
<see langword="false" />. indicates that the current stream does not
support reading.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>The value of this property is initially set by the
<see cref="T:System.Net.Sockets.NetworkStream" /> constructors and can be changed using the <see cref="P:System.Net.Sockets.NetworkStream.Readable" /> property.</para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.IO.Stream.CanRead" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="CanSeek">
<MemberSignature Language="ILASM" Value=".property bool CanSeek { public hidebysig virtual specialname bool get_CanSeek() }" />
<MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Returns the <see cref="T:System.Boolean" /> value <see langword="false" /> to indicate that the
<see cref="T:System.Net.Sockets.NetworkStream" /> class
cannot access a specific location in the data
stream.
</para>
</summary>
<value>
<para>
<see langword="false" />.</para>
</value>
<remarks>
<para> This property is read-only. </para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.IO.Stream.CanSeek" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="CanWrite">
<MemberSignature Language="ILASM" Value=".property bool CanWrite { public hidebysig virtual specialname bool get_CanWrite() }" />
<MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets a <see cref="T:System.Boolean" qualify="true" /> value indicating whether the current stream supports writing.
</para>
</summary>
<value>
<para>
<see langword="true" /> indicates that the current stream supports writing;
<see langword="false" />
indicates that the current stream does not support writing.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>The value of this property is initially set by the
<see cref="T:System.Net.Sockets.NetworkStream" />
constructors and can be changed using the <see cref="P:System.Net.Sockets.NetworkStream.Writeable" /> property.</para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.IO.Stream.CanWrite" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="DataAvailable">
<MemberSignature Language="ILASM" Value=".property bool DataAvailable { public hidebysig virtual specialname bool get_DataAvailable() }" />
<MemberSignature Language="C#" Value="public virtual bool DataAvailable { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets a <see cref="T:System.Boolean" qualify="true" /> value indicating whether data is available to be read from the underlying socket buffer.
</para>
</summary>
<value>
<para>
<see langword="true" /> indicates that data is available to be
read; <see langword="false" />
indicates that there is no data available to be read.</para>
</value>
<exception cref="T:System.ObjectDisposedException">The current instance has been disposed.</exception>
<remarks>
<para>This property is read-only.</para>
<para>
<block subset="none" type="behaviors"> As
described
above. </block>
</para>
<para>
<block subset="none" type="default">Accessing this
property causes a call to the <see cref="P:System.Net.Sockets.Socket.Available" /> method of the underlying <see cref="T:System.Net.Sockets.Socket" /> instance. If the <see langword="Available" />
method returns a
non-zero value, indicating data is available to be read, this property returns
<see langword="true" />; otherwise, this property returns
<see langword="false" />.
</block>
</para>
<para>
<block subset="none" type="overrides">Override this property
to determine if data is available to be read in the underlying socket
buffer.
</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Length">
<MemberSignature Language="ILASM" Value=".property int64 Length { public hidebysig virtual specialname int64 get_Length() }" />
<MemberSignature Language="C#" Value="public override long Length { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Throws a <see cref="T:System.NotSupportedException" />.
</para>
</summary>
<exception cref="T:System.NotSupportedException">Any attempt to access this property. </exception>
<remarks>
<block subset="none" type="note">
<para> The <see cref="T:System.IO.Stream" /> base class implements this property to return the length of the data
available on the stream. This functionality is not supported in
the <see cref="T:System.Net.Sockets.NetworkStream" /> class.</para>
<para>This property overrides <see cref="P:System.IO.Stream.Length" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Position">
<MemberSignature Language="ILASM" Value=".property int64 Position { public hidebysig virtual specialname int64 get_Position() public hidebysig virtual specialname void set_Position(int64 value) }" />
<MemberSignature Language="C#" Value="public override long Position { get; set; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Throws a <see cref="T:System.NotSupportedException" />.
</para>
</summary>
<exception cref="T:System.NotSupportedException">Any attempt to access this property.</exception>
<remarks>
<block subset="none" type="note">
<para> The <see cref="T:System.IO.Stream" /> base class implements this property to return or set the
current position in the stream. This functionality is not supported in the <see cref="T:System.Net.Sockets.NetworkStream" />
class.</para>
<para>This property overrides <see cref="P:System.IO.Stream.Position" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Readable">
<MemberSignature Language="C#" Value="protected bool Readable { set; 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="Socket">
<MemberSignature Language="C#" Value="protected System.Net.Sockets.Socket Socket { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.Socket</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Writeable">
<MemberSignature Language="C#" Value="protected bool Writeable { set; 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>
|