NetworkStream Constructor (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.
Assembly: System (in System.dll)
Parameters
- socket
- Type: System.Net.Sockets.Socket
The Socket that the NetworkStream will use to send and receive data.
- access
- Type: System.IO.FileAccess
A bitwise combination of the FileAccess values that specifies the type of access given to the NetworkStream over the provided Socket.
- ownsSocket
- Type: System.Boolean
Set to true to indicate that the NetworkStream will take ownership of the Socket; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException |
The socket parameter is null. |
| IOException |
The socket parameter is not connected. -or- The SocketType property of the socket parameter is not SocketType.Stream. -or- The socket parameter is in a nonblocking state. |
The NetworkStream is created with read/write access to the specified Socket. If the value of the ownsSocket parameter is true, the NetworkStream takes ownership of the underlying Socket, and calling the Close method also closes the underlying Socket.
The access parameter sets the CanRead and CanWrite properties of the NetworkStream. If you specify Write, then the NetworkStream allows calls to the Write method. If you specify Read, then the NetworkStream allows calls to the Read method. If you specify ReadWrite, both method calls are allowed.
The following code example creates a NetworkStream with the ability to read and write to the Socket. Ownership of the Socket is given to this NetworkStream by specifying true for the ownsSocket parameter.
// Example for creating a NetworkStreams
mySocket.Connect(myIpEndPoint);
// Create the NetworkStream for communicating with the remote host.
NetworkStream myNetworkStream;
if (networkStreamOwnsSocket){
myNetworkStream = new NetworkStream(mySocket, FileAccess.ReadWrite, true);
}
else{
myNetworkStream = new NetworkStream(mySocket, FileAccess.ReadWrite);
}
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
