WebProxy Class

Definition

Namespace:

System.Net

Assembly:

System.Net.WebProxy.dll

Source:

WebProxy.cs

Contains HTTP proxy settings for the HttpClient class.

public ref class WebProxy : System::Net::IWebProxy, System::Runtime::Serialization::ISerializable

public class WebProxy : System.Net.IWebProxy, System.Runtime.Serialization.ISerializable

type WebProxy = class
    interface IWebProxy
    interface ISerializable

Public Class WebProxy
Implements ISerializable, IWebProxy

Inheritance

Object

WebProxy

Implements

IWebProxy ISerializable

Examples

The following code example sets up an HttpClient instance with a WebProxy instance. The HttpClient instance uses the proxy to connect to external Internet resources. (For an example that demonstrates using the WPAD feature, see the documentation for the IWebProxyScript class.)

WebProxy^ proxyObject = gcnew WebProxy("http://proxyserver:80/", true);

// HttpClient lifecycle management best practices:
// https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
HttpClientHandler^ handler = gcnew HttpClientHandler();
handler->Proxy = proxyObject;
HttpClient^ client = gcnew HttpClient(handler);

WebProxy proxyObject = new WebProxy("http://proxyserver:80/", true);

// HttpClient lifecycle management best practices:
// https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
HttpClient client = new HttpClient(new HttpClientHandler
{
    Proxy = proxyObject
});

Dim proxyObject As New WebProxy("http://proxyserver:80/", True)

' HttpClient lifecycle management best practices:
' https://learn.microsoft.com/dotnet/fundamentals/networking/http/httpclient-guidelines#recommended-use
Dim client As New HttpClient(New HttpClientHandler With
{
    .Proxy = proxyObject
})

Remarks

The WebProxy class contains the proxy settings that HttpClient instances use to determine whether a Web proxy is used to send requests. Global Web proxy settings can be specified in machine and application configuration files, and applications can use instances of the WebProxy class to customize Web proxy use. The WebProxy class is the base implementation of the IWebProxy interface.

To obtain instances of the Web proxy class, you can use any of the following methods:

• The WebProxy constructor.

• The GetDefaultProxy method.

• The Select method.

These methods each supply a WebProxy instance that you can further customize; the difference between them is how the instance is initialized before it is returned to your application. The WebProxy constructor returns an instance of the WebProxy class with the Address property set to null. When a request uses a WebProxy instance in this state, no proxy is used to send the request.

The GetDefaultProxy method returns an instance of the WebProxy class with the Address, BypassProxyOnLocal, and BypassList properties set to the values used by the local computer.

The Select method returns an instance of the WebProxy class with it properties set according to a combination of Internet and configuration file settings.

The WebProxy class supports automatic detection and execution of proxy configuration scripts. This feature is also known as Web Proxy Auto-Discovery (WPAD). When using automatic proxy configuration, a configuration script, typically named Wpad.dat, must be located, downloaded, compiled, and run. If these operations are successful, the script returns the proxies that can be used for a request.

Constructors

WebProxy()	Initializes an empty instance of the WebProxy class.
WebProxy(SerializationInfo, StreamingContext)	Obsolete. Initializes an instance of the WebProxy class using previously serialized content.
WebProxy(String)	Initializes a new instance of the WebProxy class with the specified URI.
WebProxy(String, Boolean)	Initializes a new instance of the WebProxy class with the specified URI and bypass setting.
WebProxy(String, Boolean, String[])	Initializes a new instance of the WebProxy class with the specified URI, bypass setting, and list of URIs to bypass.
WebProxy(String, Boolean, String[], ICredentials)	Initializes a new instance of the WebProxy class with the specified URI, bypass setting, list of URIs to bypass, and credentials.
WebProxy(String, Int32)	Initializes a new instance of the WebProxy class with the specified host and port number.
WebProxy(Uri)	Initializes a new instance of the WebProxy class from the specified Uri instance.
WebProxy(Uri, Boolean)	Initializes a new instance of the WebProxy class with the Uri instance and bypass setting.
WebProxy(Uri, Boolean, String[])	Initializes a new instance of the WebProxy class with the specified Uri instance, bypass setting, and list of URIs to bypass.
WebProxy(Uri, Boolean, String[], ICredentials)	Initializes a new instance of the WebProxy class with the specified Uri instance, bypass setting, list of URIs to bypass, and credentials.

Properties

Address	Gets or sets the address of the proxy server.
BypassArrayList	Gets a list of addresses that do not use the proxy server.
BypassList	Gets or sets an array of addresses that do not use the proxy server.
BypassProxyOnLocal	Gets or sets a value that indicates whether to bypass the proxy server for local addresses.
Credentials	Gets or sets the credentials to submit to the proxy server for authentication.
UseDefaultCredentials	Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDefaultProxy()	Obsolete. Reads the Internet options nondynamic proxy settings.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Populates a SerializationInfo with the data that is needed to serialize the target object.
GetProxy(Uri)	Returns the proxied URI for a request.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsBypassed(Uri)	Indicates whether to use the proxy server for the specified host.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Creates the serialization data and context that are used by the system to serialize a WebProxy object.