Proxy Manager. More...
#import <ZDKProxyManager.h>
Instance Methods | |
| (id< ZDKProxyConfig >) | - createProxyConfig:mode:hostname:port:username:password: |
| Creates a new Proxy configuration with the given parameters. More... | |
| (id< ZDKResult >) | - setProxyConfig: |
| Sets the current proxy configuration. More... | |
| (id< ZDKProxyConfig >) | - getProxyConfig:mode: |
| Gets the current proxy configuration. More... | |
| (id< ZDKProxyConfig >) | - getProxyConfigForURL: |
| Gets the current proxy configuration for the specified URL. More... | |
| (NSString *) | - handlesDescription |
 Instance Methods inherited from <ZDKZHandle> | |
| (long int) | - handle |
| (void) | - initialize |
| (void) | - releaseReference |
| (NSString *) | - handlesDescription |
Detailed Description
Proxy Manager.
Method Documentation
◆ createProxyConfig:mode:hostname:port:username:password:
| - (id< ZDKProxyConfig >) createProxyConfig: | (ZDKProxyProtocolType) | protocol | |
| mode: | (ZDKProxyModeType) | mode | |
| hostname: | (NSString *_Nullable) | hostname | |
| port: | (unsigned int) | port | |
| username: | (NSString *) | username | |
| password: | (NSString *) | 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
- ZDKProxyConfig
◆ getProxyConfig:mode:
| - (id< ZDKProxyConfig >) getProxyConfig: | (ZDKProxyProtocolType) | protocol | |
| mode: | (ZDKProxyModeType) | 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
- ZDKProxyConfig
◆ getProxyConfigForURL:
| - (id< ZDKProxyConfig >) getProxyConfigForURL: | (NSString *) | 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
- ZDKProxyConfig
◆ handlesDescription
| - (NSString *) handlesDescription |
Reimplemented from <ZDKZHandle>.
◆ setProxyConfig:
| - (id< ZDKResult >) setProxyConfig: | (id< ZDKProxyConfig >) | 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
- ZDKProxyConfig
The documentation for this protocol was generated from the following file:
- Providers/ZDKProxyManager.h
