NetworkStream Class

 

Provides the underlying stream of data for network access.

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

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

public class NetworkStream : Stream

NameDescription
System_CAPS_pubmethodNetworkStream(Socket)

Creates a new instance of the NetworkStream class for the specified Socket.

System_CAPS_pubmethodNetworkStream(Socket, Boolean)

Initializes a new instance of the NetworkStream class for the specified Socket with the specified Socket ownership.

System_CAPS_pubmethodNetworkStream(Socket, FileAccess)

Creates a new instance of the NetworkStream class for the specified Socket with the specified access rights.

System_CAPS_pubmethodNetworkStream(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.

NameDescription
System_CAPS_pubpropertyCanRead

Gets a value that indicates whether the NetworkStream supports reading.(Overrides Stream.CanRead.)

System_CAPS_pubpropertyCanSeek

Gets a value that indicates whether the stream supports seeking. This property is not currently supported.This property always returns false.(Overrides Stream.CanSeek.)

System_CAPS_pubpropertyCanTimeout

Indicates whether timeout properties are usable for NetworkStream.(Overrides Stream.CanTimeout.)

System_CAPS_pubpropertyCanWrite

Gets a value that indicates whether the NetworkStream supports writing.(Overrides Stream.CanWrite.)

System_CAPS_pubpropertyDataAvailable

Gets a value that indicates whether data is available on the NetworkStream to be read.

System_CAPS_pubpropertyLength

Gets the length of the data available on the stream. This property is not currently supported and always throws a NotSupportedException.(Overrides Stream.Length.)

System_CAPS_pubpropertyPosition

Gets or sets the current position in the stream. This property is not currently supported and always throws a NotSupportedException.(Overrides Stream.Position.)

System_CAPS_protpropertyReadable

Gets or sets a value that indicates whether the NetworkStream can be read.

System_CAPS_pubpropertyReadTimeout

Gets or sets the amount of time that a read operation blocks waiting for data. (Overrides Stream.ReadTimeout.)

System_CAPS_protpropertySocket

Gets the underlying Socket.

System_CAPS_protpropertyWriteable

Gets a value that indicates whether the NetworkStream is writable.

System_CAPS_pubpropertyWriteTimeout

Gets or sets the amount of time that a write operation blocks waiting for data. (Overrides Stream.WriteTimeout.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read from the NetworkStream.(Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write to a stream.(Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodClose()

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.)

System_CAPS_pubmethodClose(Int32)

Closes the NetworkStream after waiting the specified time to allow data to be sent.

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(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.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodCreateWaitHandle()

Obsolete.Allocates a WaitHandle object.(Inherited from Stream.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the NetworkStream and optionally releases the managed resources.(Overrides Stream.Dispose(Boolean).)

System_CAPS_pubmethodEndRead(IAsyncResult)

Handles the end of an asynchronous read.(Overrides Stream.EndRead(IAsyncResult).)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Handles the end of an asynchronous write.(Overrides Stream.EndWrite(IAsyncResult).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases all resources used by the NetworkStream.(Overrides Object.Finalize().)

System_CAPS_pubmethodFlush()

Flushes data from the stream. This method is reserved for future use.(Overrides Stream.Flush().)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Flushes data from the stream as an asynchronous operation.(Overrides Stream.FlushAsync(CancellationToken).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodObjectInvariant()

Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. Provides support for a Contract.(Inherited from Stream.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads data from the NetworkStream.(Overrides Stream.Read(Byte[], Int32, Int32).)

System_CAPS_pubmethodReadAsync(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.)

System_CAPS_pubmethodReadAsync(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.)

System_CAPS_pubmethodReadByte()

Reads 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.)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

Sets 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).)

System_CAPS_pubmethodSetLength(Int64)

Sets the length of the stream. This method always throws a NotSupportedException.(Overrides Stream.SetLength(Int64).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

Writes data to the NetworkStream.(Overrides Stream.Write(Byte[], Int32, Int32).)

System_CAPS_pubmethodWriteAsync(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.)

System_CAPS_pubmethodWriteAsync(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.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.(Inherited from Stream.)

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 StreamSocket 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.
NetworkStream myNetworkStream;

if (networkStreamOwnsSocket){
     myNetworkStream = new NetworkStream(mySocket, true);          
}
else{
     myNetworkStream = new NetworkStream(mySocket);     
}

.NET Framework
Available since 1.1

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

Return to top
Show: