Skip to content

Commit b0a959b

Browse files
socksVersion defines the protocol version for socks protocol
1 parent 1e0853d commit b0a959b

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

index.html

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1645,21 +1645,37 @@ <h3>Proxy</h3>
16451645
<tr>
16461646
<td><code>socksProxy</code>
16471647
<td>string
1648-
<td>Defines the proxy <a>host</a> for a <a>SOCKS proxy</a>
1649-
when the <a><code>proxyType</code></a> is "<code>manual</code>".
1648+
<td>Defines the proxy <a>host</a> for SOCKS traffic when the
1649+
<a><code>proxyType</code></a> is "<code>manual</code>".
16501650
<td>A <a>proxy url</a>.
16511651
</tr>
16521652

1653+
<tr>
1654+
<td><code>socksVersion</code>
1655+
<td>number
1656+
<td>Defines the <a>SOCKS proxy</a> version when the <a>proxy url</a>'s
1657+
<a>proxy scheme</a> is "<code>socks</code>".
1658+
<td>Any <a>integer</a> between 0 and 255 inclusive.
1659+
</tr>
1660+
16531661
</table>
16541662

1655-
<p>A <dfn>proxy url</dfn> consists of an optional <a>proxy scheme</a>
1656-
followed by the string "<code>://</code>", a valid <a>host</a>,
1657-
and optionally a colon followed by a valid <a>port</a>. The <a>host</a>
1658-
may <a data-lt="includes credentials">include credentials</a>. If the
1659-
<var>scheme</var> is omitted, the <var>scheme</var> is implied to be
1660-
"<code>http</code>". If the port is omitted and <var>scheme</var> has a
1661-
<a>default port</a>, this is the implied port. Otherwise, the port is left
1662-
undefined.
1663+
<p>A <dfn>proxy url</dfn> can be either "<code>direct</code>" or a string
1664+
consists of an optional <a>proxy scheme</a> <var>scheme</var> followed by the
1665+
string "<code>://</code>", a valid <a>host</a> <var>host</var>, and optionally
1666+
a colon followed by a valid <a>port</a> <var>port</var>.
1667+
1668+
<ol>
1669+
<li><p>The <var>host</var> may
1670+
<a data-lt="includes credentials">include credentials</a>.
1671+
<li><p>If the <var>port</var> is omitted and <var>scheme</var> has a
1672+
<a>default port</a>, this is the implied port. Otherwise, the <var>port</var>
1673+
is left undefined.
1674+
1675+
<li><p>If the <var>scheme</var> is omitted and the <var>port</var> is 443,
1676+
the <var>scheme</var> is implied to be "<code>https</code>". Otherwise, the
1677+
<var>scheme</var> is implied to be "<code>http</code>".
1678+
</ol>
16631679

16641680
<p>A <dfn>proxy scheme</dfn> is defined as being one of the following strings:
16651681
"<code>http</code>", "<code>https</code>", "<code>socks</code>",
@@ -1716,10 +1732,10 @@ <h3>Proxy</h3>
17161732
<a>own property</a> for "<code>proxyAutoconfigUrl</code>" return
17171733
an <a>error</a> with <a>error code</a> <a>invalid argument</a>.
17181734

1719-
<li><p>If <var>proxy</var> has an <a>own property</a> for
1720-
"<code>socksProxy</code>" and does not have an <a>own property</a>
1721-
for "<code>socksVersion</code>" return an <a>error</a> with <a>error
1722-
code</a> <a>invalid argument</a>.
1735+
<li><p>If <var>proxy</var> contains <a>proxy url</a> with <a>proxy scheme</a>
1736+
"<code>socks</code>" and does not have an <a>own property</a>
1737+
for "<code>socksVersion</code>", return an <a>error</a> with <a>error code</a>
1738+
<a>invalid argument</a>.
17231739

17241740
<li><p>Return <a>success</a> with data <var>proxy</var>.
17251741
</ol>

0 commit comments

Comments
 (0)