System.Net.Sockets.TransmitFileOptions Enumeration

The System.Net.Sockets.TransmitFileOptions enumeration defines values used in file transfer requests.

Syntax

[System.Flags]
public enum TransmitFileOptions

Remarks

Note   The flags TransmitFileOptions.Disconnect and TransmitFileOptions.ReuseSocket return the socket to a disconnected, reusable state after the file has been transmitted. These flags should not be used on a socket where quality of service (QOS) has been requested, because the service provider might immediately delete any quality of service associated with the socket before the file transfer has completed. The best approach for a QOS-enabled socket is to call Socket.Close when the file transfer has completed, rather than relying on these flags.

Members

Member NameDescription
Disconnect

Start a transport-level disconnect after all the file data has been queued for transmission. When used with TransmitFileOptions.ReuseSocket, these flags return the socket to a disconnected, reusable state after the file has been transmitted.

ReuseSocket

The socket handle may be reused when the request completes. This flag is valid only if TransmitFileOptions.Disconnect is also specified. When used with TransmitFileOptions.Disconnect, these flags return the socket to a disconnected, reusable state after the file has been transmitted.

UseDefaultWorkerThread

Use the default thread to process long file transfer requests.

UseKernelApc

Use kernel asynchronous procedure calls (APCs) instead of worker threads to process long file transfer requests. Long requests are defined as requests that require more than a single read from the file or a cache; the request therefore depends on the size of the file and the specified length of the send packet.

UseSystemThread

Use system threads to process long file transfer requests.

WriteBehind

Complete the file transfer request immediately, without pending. If this flag is specified and the file transfer succeeds, the data has been accepted by the system but not necessarily acknowledged by the remote end. Do not use this flag with the TransmitFileOptions.Disconnect and TransmitFileOptions.ReuseSocket flags.

Requirements

Namespace: System.Net.Sockets
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0