WSB_ProxyManager Class

The global Wasabi HTTP Proxy control. More...

Functions
WSB_EXPORT WSB_Result	WSB_ProxyManager_SetHttpProxy (const char *hostname, WSB_UInt16 port)
	Sets the http proxy to be used for all http transactions within Wasabi. More...
WSB_EXPORT WSB_Result	WSB_ProxyManager_SetHttpsProxy (const char *hostname, WSB_UInt16 port)
	Set the https proxy to be used for all https transactions within Wasabi If 'hostname' is an empty string (""), it resets the https proxy settings whereby the proxy is bypassed and Wasabi tries a direct https connection. More...
WSB_EXPORT WSB_Result	WSB_ProxyManager_SetHttpProxyAuthentication (WSB_Boolean is_auth, const char *username, const char *password)
	Set the http proxy authentication to be used for all http transactions. More...
WSB_EXPORT WSB_Result	WSB_ProxyManager_SetHttpsProxyAuthentication (WSB_Boolean is_auth, const char *username, const char *password)
	Set the https proxy authentication to be used for all https transactions. More...

Detailed Description

The global Wasabi HTTP Proxy control.

Function Documentation

WSB_ProxyManager_SetHttpProxy()

WSB_EXPORT WSB_Result WSB_ProxyManager_SetHttpProxy	(	const char *	hostname,
		WSB_UInt16	port
	)

Sets the http proxy to be used for all http transactions within Wasabi.

If 'hostname' is an empty string (""), it resets the http proxy settings whereby the proxy is bypassed and Wasabi tries a direct http connection

Parameters

hostname	a dns name or ip address string of the proxy server
port	a valid port that the proxy server is listening on for http traffic

Returns

WSB_SUCCESS on success.

WSB_ProxyManager_SetHttpProxyAuthentication()

WSB_EXPORT WSB_Result WSB_ProxyManager_SetHttpProxyAuthentication	(	WSB_Boolean	is_auth,
		const char *	username,
		const char *	password
	)

Set the http proxy authentication to be used for all http transactions.

Parameters

is_auth	if set to WSB_TRUE, 'username' and 'password' are used for authenticating the connection to the http proxy. If WSB_FALSE, proxy authentication is turned off and 'username' and 'password' params are ignored
username	a valid username that's configured on the proxy
password	the password for the supplied 'username'

Returns

WSB_SUCCESS on success.

Since

1.11

WSB_ProxyManager_SetHttpsProxy()

WSB_EXPORT WSB_Result WSB_ProxyManager_SetHttpsProxy	(	const char *	hostname,
		WSB_UInt16	port
	)

Set the https proxy to be used for all https transactions within Wasabi If 'hostname' is an empty string (""), it resets the https proxy settings whereby the proxy is bypassed and Wasabi tries a direct https connection.

Parameters

hostname	a dns name or ip address string of the proxy server
port	a valid port that the proxy server is listening on for https traffic

Returns

WSB_SUCCESS on success.

WSB_ProxyManager_SetHttpsProxyAuthentication()

WSB_EXPORT WSB_Result WSB_ProxyManager_SetHttpsProxyAuthentication	(	WSB_Boolean	is_auth,
		const char *	username,
		const char *	password
	)

Set the https proxy authentication to be used for all https transactions.

Parameters

is_auth	if set to WSB_TRUE, 'username' and 'password' are used for authenticating the connection to the https proxy. If WSB_FALSE, proxy authentication is turned off and 'username' and 'password' params are ignored
username	a valid username that's configured on the proxy
password	the password for the supplied 'username'

Returns

WSB_SUCCESS on success.

Since

1.11