Export (0) Print
Expand All

NetworkStream Class

Provides the underlying stream of data for network access.

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.Net.Sockets.NetworkStream

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

'Declaration
Public Class NetworkStream _
	Inherits 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.
Public methodNetworkStream(Socket, FileAccess)Creates a new instance of the NetworkStream class for the specified Socket with the specified access rights.
Public methodNetworkStream(Socket, FileAccess, Boolean)Creates a new instance of the NetworkStream class for the specified Socket with the specified access rights and 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.)
Protected propertyReadableGets or sets a value that indicates whether the NetworkStream can be read.
Public propertyReadTimeoutGets or sets the amount of time that a read operation blocks waiting for data. (Overrides Stream.ReadTimeout.)
Protected propertySocketGets the underlying Socket.
Protected propertyWriteableGets a value that indicates whether the NetworkStream is writable.
Public propertyWriteTimeoutGets or sets the amount of time that a write operation blocks waiting for data. (Overrides Stream.WriteTimeout.)
Top

  NameDescription
Public methodBeginReadBegins an asynchronous read from the NetworkStream. (Overrides Stream.BeginRead(Byte(), Int32, Int32, AsyncCallback, Object).)
Public methodBeginWriteBegins an asynchronous write to a stream. (Overrides Stream.BeginWrite(Byte(), Int32, Int32, AsyncCallback, Object).)
Public methodCloseCloses 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 methodCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32, CancellationToken)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. (Inherited from Stream.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected methodCreateWaitHandle Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
Public methodDisposeReleases 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 methodEndReadHandles the end of an asynchronous read. (Overrides Stream.EndRead(IAsyncResult).)
Public methodEndWriteHandles the end of an asynchronous write. (Overrides Stream.EndWrite(IAsyncResult).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases all resources used by the NetworkStream. (Overrides Object.Finalize.)
Public methodFlushFlushes data from the stream. This method is reserved for future use. (Overrides Stream.Flush.)
Public methodFlushAsyncAsynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
Public methodFlushAsync(CancellationToken)Flushes data from the stream as an asynchronous operation. (Overrides Stream.FlushAsync(CancellationToken).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodObjectInvariantInfrastructure. Obsolete. Provides support for a Contract. (Inherited from Stream.)
Public methodReadReads data from the NetworkStream. (Overrides Stream.Read(Byte(), Int32, Int32).)
Public methodReadAsync(Byte(), Int32, Int32)Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream.)
Public methodReadAsync(Byte(), Int32, Int32, CancellationToken)Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream.)
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(Byte(), Int32, Int32).)
Public methodWriteAsync(Byte(), Int32, Int32)Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream.)
Public methodWriteAsync(Byte(), Int32, Int32, CancellationToken)Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream.)
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

The NetworkStream class provides methods for sending and receiving data over Stream sockets in blocking mode. For more information about blocking versus nonblocking Sockets, see Using an Asynchronous Client Socket. You can use the NetworkStream class for both synchronous and asynchronous data transfer. For more information about synchronous and asynchronous communication, see Sockets.

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. If you want to process your I/O using separate threads, consider using the BeginWrite and EndWrite methods, or the BeginRead and EndRead methods for communication.

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.

The following code example demonstrates how to create a NetworkStream from a connected Stream Socket and perform basic synchronous blocking I/O.

' Examples for constructors that do not specify file permission. 
' Create the NetworkStream for communicating with the remote host. 
Dim myNetworkStream As NetworkStream

If networkStreamOwnsSocket Then
   myNetworkStream = New NetworkStream(mySocket, True)
Else
   myNetworkStream = New NetworkStream(mySocket)
End If

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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:
© 2014 Microsoft