socks.sgml

unix/linux general net toolkit

<!-- ##### SECTION Title ##### -->
SOCKS

<!-- ##### SECTION Short_Description ##### -->
SOCKS proxy

<!-- ##### SECTION Long_Description ##### -->
<para>
SOCKS is a TCP proxy protocol.  Typically, a host behind a firewall
uses SOCKS to connect to hosts outside the firewall via a SOCKS proxy
server.  To open a TCP connection, a SOCKS client connects to a SOCKS
server and the SOCKS server connects to the destination.  Data is then
forwarded between the client and the destination by the SOCKS server.
GNet supports SOCKS versions 4 and 5.  Version 5 includes support for
server sockets.
</para>

<para>
SOCKS is used if the SOCKS_SERVER environment variable is set or
gnet_socks_set_server() is called to set the SOCKS server's address.
To disable SOCKS support, call gnet_socks_set_enabled() and pass
FALSE.  The SOCKS_VERSION environment variable controls which SOCKS
version is used.  The default is version 5.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### MACRO GNET_SOCKS_PORT ##### -->
<para>

</para>



<!-- ##### MACRO GNET_SOCKS_VERSION ##### -->
<para>

</para>



<!-- ##### FUNCTION gnet_socks_get_enabled ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gnet_socks_set_enabled ##### -->
<para>

</para>

@enabled: 


<!-- ##### FUNCTION gnet_socks_get_server ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gnet_socks_set_server ##### -->
<para>

</para>

@inetaddr: 
<!-- # Unused Parameters # -->
@ia: 


<!-- ##### FUNCTION gnet_socks_get_version ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gnet_socks_set_version ##### -->
<para>

</para>

@version: