NetworkStream Class

Definition

Provides the underlying stream of data for network access.

public class NetworkStream : System.IO.Stream
Inheritance

Inherited Members

System.IO.Stream

System.MarshalByRefObject

System.Object

Examples

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 = gcnew NetworkStream( mySocket,true );
}
else
{
   myNetworkStream = gcnew NetworkStream( mySocket );
}
// 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);     
}
' 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

Remarks

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.

Constructors

NetworkStream(Socket)

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

NetworkStream(Socket, Boolean)

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

NetworkStream(Socket, FileAccess)

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

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

Properties

CanRead

Gets a value that indicates whether the NetworkStream supports reading.

CanSeek

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

CanTimeout

Indicates whether timeout properties are usable for NetworkStream.

CanWrite

Gets a value that indicates whether the NetworkStream supports writing.

DataAvailable

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

Length

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

Position

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

Readable

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

ReadTimeout

Gets or sets the amount of time that a read operation blocks waiting for data.

Socket

Gets the underlying Socket.

Writeable

Gets a value that indicates whether the NetworkStream is writable.

WriteTimeout

Gets or sets the amount of time that a write operation blocks waiting for data.

Methods

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

Begins an asynchronous read from the NetworkStream.

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

Begins an asynchronous write to a stream.

Close(Int32)

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

Dispose(Boolean)

Releases the unmanaged resources used by the NetworkStream and optionally releases the managed resources.

EndRead(IAsyncResult)

Handles the end of an asynchronous read.

EndWrite(IAsyncResult)

Handles the end of an asynchronous write.

Finalize()

Releases all resources used by the NetworkStream.

Flush()

Flushes data from the stream. This method is reserved for future use.

FlushAsync(CancellationToken)

Flushes data from the stream as an asynchronous operation.

Read(Byte[], Int32, Int32)

Reads data from the NetworkStream.

ReadAsync(Byte[], Int32, Int32, CancellationToken)
Seek(Int64, SeekOrigin)

Sets the current position of the stream to the given value. This method is not currently supported and always throws a NotSupportedException.

SetLength(Int64)

Sets the length of the stream. This method always throws a NotSupportedException.

Write(Byte[], Int32, Int32)

Writes data to the NetworkStream.

WriteAsync(Byte[], Int32, Int32, CancellationToken)