NetworkStream Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Provides the underlying stream of data for network access.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

public class NetworkStream : Stream

The NetworkStream type exposes the following members.

  NameDescription
Public methodNetworkStream(Socket)Creates a new instance of the NetworkStream class for the specified Socket.
Public methodNetworkStream(Socket, Boolean)Initializes a new instance of the NetworkStream class for the specified Socket with the specified Socket ownership.
Top

  NameDescription
Public propertyCanReadGets a value that indicates whether the NetworkStream supports reading. (Overrides Stream..::..CanRead.)
Public propertyCanSeekGets a value that indicates whether the stream supports seeking. This property is not currently supported.This property always returns false. (Overrides Stream..::..CanSeek.)
Public propertyCanTimeoutIndicates whether timeout properties are usable for NetworkStream. (Overrides Stream..::..CanTimeout.)
Public propertyCanWriteGets a value that indicates whether the NetworkStream supports writing. (Overrides Stream..::..CanWrite.)
Public propertyDataAvailableGets a value that indicates whether data is available on the NetworkStream to be read.
Public propertyLengthGets the length of the data available on the stream. This property is not currently supported and always throws a NotSupportedException. (Overrides Stream..::..Length.)
Public propertyPositionGets or sets the current position in the stream. This property is not currently supported and always throws a NotSupportedException. (Overrides Stream..::..Position.)
Public propertyReadTimeoutGets or sets the amount of time that a read operation blocks waiting for data. (Overrides Stream..::..ReadTimeout.)
Public propertyWriteTimeoutGets or sets the amount of time that a write operation blocks waiting for data. (Overrides Stream..::..WriteTimeout.)
Top

  NameDescription
Public methodClose()()()()Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream.)
Public methodClose(Int32)Closes the NetworkStream after waiting the specified time to allow data to be sent.
Public methodDispose()()()()Releases all resources used by the Stream. (Inherited from Stream.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the NetworkStream and optionally releases the managed resources. (Overrides Stream..::..Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeCleans up resources. (Inherited from Stream.)
Public methodFlushFlushes data from the stream. This method is reserved for future use. (Overrides Stream..::..Flush()()()().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadReads data from the NetworkStream. (Overrides Stream..::..Read(array<Byte>[]()[][], Int32, Int32).)
Public methodReadByteReads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. (Inherited from Stream.)
Public methodSeekSets the current position of the stream to the given value. This method is not currently supported and always throws a NotSupportedException. (Overrides Stream..::..Seek(Int64, SeekOrigin).)
Public methodSetLengthSets the length of the stream. This method always throws a NotSupportedException. (Overrides Stream..::..SetLength(Int64).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteWrites data to the NetworkStream. (Overrides Stream..::..Write(array<Byte>[]()[][], Int32, Int32).)
Public methodWriteByteWrites a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.)
Top

  NameDescription
Protected field_disposedIndicates whether the NetworkStream has been disposed.
Protected field_remoteEndPointContains the stream's remote endpoint.
Protected field_socketTypeContains the socket type.
Top

To create a NetworkStream, you must provide a connected Socket. You can also specify what FileAccess permission the NetworkStream has over the provided Socket. By default, closing the NetworkStream does not close the provided Socket. If you want the NetworkStream to have permission to close the provided Socket, you must specify true for the value of the ownsSocket parameter.

Use the Write and Read methods for simple single thread synchronous blocking I/O.

The NetworkStream does not support random access to the network data stream. The value of the CanSeek property, which indicates whether the stream supports seeking, is always false; reading the Position property, reading the Length property, or calling the Seek method will throw a NotSupportedException.

Read and write operations can be performed simultaneously on an instance of the NetworkStream class without the need for synchronization. As long as there is one unique thread for the write operations and one unique thread for the read operations, there will be no cross-interference between read and write threads and no synchronization is required.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: