[#Proxy]
= Proxy
:mrdocs:

A proxy endpoint, either a network service or a local unix domain socket.

== Synopsis

Declared in `<netbase.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Proxy;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:Proxy/2constructor-0a.adoc[`Proxy`]         [.small]#[constructor]#
| Constructors
| xref:Proxy/Connect.adoc[`Connect`] 
| Open a connection to this proxy.
| xref:Proxy/GetFamily.adoc[`GetFamily`] 
| Get the socket address family of this proxy.
| xref:Proxy/IsValid.adoc[`IsValid`] 
| Check whether this proxy is valid.
| xref:Proxy/ToString.adoc[`ToString`] 
| Get a human‐readable representation of this proxy.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:Proxy/m_is_unix_socket.adoc[`m_is_unix_socket`] 
| Whether this proxy is a local unix domain socket.
| xref:Proxy/m_tor_stream_isolation.adoc[`m_tor_stream_isolation`] 
| Whether Tor stream isolation is enabled for this proxy.
| xref:Proxy/m_unix_socket_path.adoc[`m_unix_socket_path`] 
| Filesystem path of the unix domain socket (unused for service proxies).
| xref:Proxy/proxy.adoc[`proxy`] 
| The proxy network service address (unused for unix socket proxies).
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:ConnectThroughProxy.adoc[`ConnectThroughProxy`]
| Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy.
| xref:GetNameProxy.adoc[`GetNameProxy`]
| Get the configured name proxy, if any.
| xref:GetProxy.adoc[`GetProxy`]
| Get the proxy configured for a given network, if any.
| xref:SetNameProxy.adoc[`SetNameProxy`]
| Set the name proxy to use for all connections to nodes specified by a hostname. After setting this proxy, connecting to a node specified by a hostname won't result in a local lookup of said hostname, rather, connect to the node by asking the name proxy for a proxy connection to the hostname, effectively delegating the hostname lookup to the specified proxy.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#