Proxy (HttpRequest property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:HTTPRequest:Proxy subtitle}}
[[Category:HTTPRequest methods|Proxy property]]


This settable method permits the use of proxy servers with the
This settable method permits the use of proxy servers with the
Line 10: Line 9:
current proxy server (or a zero length string, if no proxy was set).
current proxy server (or a zero length string, if no proxy was set).
==Syntax==
==Syntax==
<p class="syntax">%httpreq:Proxy = ProxyServer
{{Template:HTTPRequest:Proxy syntax}}
 
%curr = %httpreq:Proxy
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 31: Line 26:
If <var>Proxy</var> is set multiple times, the most recent setting is used
If <var>Proxy</var> is set multiple times, the most recent setting is used
as the proxy server.
as the proxy server.
==See also==
{{Template:HTTPRequest:Proxy footer}}

Revision as of 18:26, 15 June 2011

Template:HTTPRequest:Proxy subtitle

This settable method permits the use of proxy servers with the HTTPRequest object.

If you specify a proxy server by setting Proxy, subsequent Get, Post, and Send calls use this proxy server. If referenced by an HTTPRequest object, Proxy returns the current proxy server (or a zero length string, if no proxy was set).

Syntax

Template:HTTPRequest:Proxy syntax

Syntax terms

%httpreq A previously defined and instantiated HTTPRequest object.
ProxyServer Identifies the proxy server to use, and is of form:

[Protocol://]Host[:Port]

  • Protocol is http or https and defaults to http. It controls the protocol used for the connection to the proxy server.
  • Host specifies either the IP number or the DNS name of the proxy server. It must be specified or the request is cancelled.
  • Port specifies the port number for the proxy server. If it is not specified, the default for the protocol (http is 80, and https is 443) is used.
%curr The string or longstring variable for the assignment of the current value of Proxy. If no Proxy value has been set, %curr is assigned a zero-length string.

Usage notes

If Proxy is set multiple times, the most recent setting is used as the proxy server.

See also

Template:HTTPRequest:Proxy footer