Proxy Manager. More...
#include <ProxyManager.h>
Public Member Functions | |
| ProxyManager (ZDK::Shared::ProxyManager src) | |
| ZDK_NET::ProxyConfig ^ | CreateProxyConfig (ZDK_NET::ProxyProtocolType protocol, ZDK_NET::ProxyModeType mode, System::String^ hostname, unsigned int port, System::String^ username, System::String^ password) |
| Creates a new Proxy configuration with the given parameters. More... | |
| ZDK_NET::Result ^ | SetProxyConfig (ZDK_NET::ProxyConfig^ value) |
| Sets the current proxy configuration. More... | |
| ZDK_NET::ProxyConfig ^ | GetProxyConfig (ZDK_NET::ProxyProtocolType protocol, ZDK_NET::ProxyModeType mode) |
| Gets the current proxy configuration. More... | |
| ZDK_NET::ProxyConfig ^ | GetProxyConfigForURL (System::String^ url) |
| Gets the current proxy configuration for the specified URL. More... | |
| virtual long long | Handle () override |
| virtual void | Initialize () override |
| virtual void | ReleaseReference () override |
Public Attributes | |
| ZDK::IProxyManager * | cppRef = nullptr |
Detailed Description
Proxy Manager.
Member Function Documentation
◆ CreateProxyConfig()
| ZDK_NET::ProxyConfig ^ ZDK_NET::ProxyManager::CreateProxyConfig | ( | ZDK_NET::ProxyProtocolType | protocol, |
| ZDK_NET::ProxyModeType | mode, | ||
| System::String^ | hostname, | ||
| unsigned int | port, | ||
| System::String^ | username, | ||
| System::String^ | password | ||
| ) |
Creates a new Proxy configuration with the given parameters.
If mode is ZDK::ProxyModeType::Environemnt, the environment/system settings are used and arugments hostname and port are ignored. If mode is ZDK::ProxyModeType::Custom, the provided hostname and port are used.
If set the username and password will be used to authenticate the proxy (works for both Envirenment/System and Custom proxies)
- Parameters
-
[in] protocol The protocol whose settings to configure [in] mode Which settings to set [in] hostname The hostname of the configured proxy [in] port The port of the configured proxy [in] username The username to use when authenticating [in] password The password to use when authenticating
- Returns
- New proxy configuration
- See also
- ProxyConfig
◆ GetProxyConfig()
| ZDK_NET::ProxyConfig ^ ZDK_NET::ProxyManager::GetProxyConfig | ( | ZDK_NET::ProxyProtocolType | protocol, |
| ZDK_NET::ProxyModeType | mode | ||
| ) |
Gets the current proxy configuration.
Gets the currently configured proxy for given protocol. If mode is ZDK::ProxyModeType::Custom, the function gets the currently selected settings. If mode is ZDK::ProxyModeType::Environemnt, the function gets the environment/system settings.
NOTE! Proxy authentication credentials (username and password) will NOT be retrieved!
- Parameters
-
[in] protocol The protocol whose settings to get [in] mode Which settings to get
- Returns
- The currently used proxy configuration if set, or nullptr otherwise.
- See also
- ProxyConfig
◆ GetProxyConfigForURL()
| ZDK_NET::ProxyConfig ^ ZDK_NET::ProxyManager::GetProxyConfigForURL | ( | System::String^ | url | ) |
Gets the current proxy configuration for the specified URL.
- Parameters
-
[in] url The URL to check against
- Returns
- The currently used proxy configuration if set, or nullptr otherwise.
- See also
- ProxyConfig
◆ SetProxyConfig()
| ZDK_NET::Result ^ ZDK_NET::ProxyManager::SetProxyConfig | ( | ZDK_NET::ProxyConfig^ | value | ) |
Sets the current proxy configuration.
Changes the current proxy configuration to use for specified protocol requests. If mode is ZDK::ProxyModeType::Environemnt, the environment/system settings are used and arugments hostname and port are ignored. If mode is ZDK::ProxyModeType::Custom, the provided hostname and port are used.
- Parameters
-
[in] value The configuration to set
- Returns
- Result of the setting
- See also
- ProxyConfig
The documentation for this class was generated from the following file:
- Providers/ProxyManager.h
