SocketTools .NET Edition

HttpClient.Priority Property

Gets and sets a value which specifies the priority of data transfers.

[Visual Basic]
Public Property Priority As HttpPriority
[C#]
public HttpClient.HttpPriority Priority {get; set;}

Property Value

Returns a HttpPriority enumeration value which specify the current data transfer priority. The default value for this property is priorityNormal.

Remarks

The Priority property can be used to control the processor usage, memory and network bandwidth allocated for data transfers. The default priority balances resource utilization and transfer speed while ensuring that a single-threaded application remains responsive to the user. Lower priorities reduce the overall resource utilization at the expense of transfer speed. For example, if you create a worker thread to download a file in the background and want to ensure that it has a minimal impact on the process, the priorityBackground value can be used.

Higher priority values increase the memory allocated for the transfers and increases processor utilization for the transfer. The priorityCritical priority maximizes transfer speed at the expense of system resources. It is not recommended that you increase the data transfer priority unless you understand the implications of doing so and have thoroughly tested your application. If the data transfer is being performed in the main UI thread, increasing the priority may interfere with the normal processing of Windows messages and cause the application to appear to become non-responsive. It is also important to note that when the priority is set to priorityCritical, normal progress events will not be generated during the transfer.

See Also

HttpClient Class | SocketTools Namespace | HttpPriority Enumeration