Share via

Networking_Proxy_SetProxyAddress Function

  • Article

Header: #include <applibs/networking.h>

Sets the proxy address for a Networking_ProxyConfig struct.

  int Networking_Proxy_SetProxyAddress(Networking_ProxyConfig *proxyConfig, const char *proxyAddress, uint16_t proxyPort);

Parameters

  • proxyConfig A pointer to the Networking_ProxyConfig struct to update.

  • proxyAddress A pointer to a null-terminated string containing the address of the proxy.

  • proxyPort The port to use on the proxy.

Errors

If an error is encountered, returns -1 and sets errno to the error value.

  • EFAULT: The proxyConfig or proxyAddress parameter is NULL.

  • ERANGE: The proxyAddress length is greater than PROXY_ADDRESS_MAX_LENGTH or is not null-terminated.

Any other errno may also be specified; such errors aren't deterministic and there's no guarantee that the same behavior will be retained through system updates.

Returns

0 for success, or -1 for failure, in which case errno will be set to the error value.

Concepts and samples

The proxy code snippets demonstrate the following:

  • The Configure Proxy Settings code snippet demonstrates how to configure the proxy settings on an Azure Sphere device.
  • The Get Proxy Settings code snippet demonstrates how to retrieve the proxy settings on an Azure Sphere device.
  • The Enable/Disable Configured Proxy code snippet demonstrates how to enable/disable an already configured proxy on an Azure Sphere device.

The HTTPS samples demonstrate using the HTTPS_Curl_Easy and HTTPS_Curl_Multi APIs to fetch content over HTTPS. By default, they configure the cURL handle to use a proxy.

The AzureIoT sample contains instructions and code for adding web proxy support to the sample.