[#i2p-sam-Session-Connect]
= xref:i2p.adoc[i2p]::xref:i2p/sam.adoc[sam]::xref:i2p/sam/Session.adoc[Session]::Connect
:relfileprefix: ../../../
:mrdocs:

Connect to an I2P peer.

== Synopsis

Declared in `<i2p.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[requires_capability(0x7ff36e7f9a98), requires_capability(0x7ff38bed2038), requires_capability(0x7ff37e47f3e8), requires_capability(0x7ff3765dc798), requires_capability(0x7ff38e223688), requires_capability(0x7ff37c5ea288), requires_capability(0x7ff38d76f908), requires_capability(0x7ff36c0012a8), requires_capability(0x7ff35c25f018), requires_capability(0x7ff382ddf468), requires_capability(0x7ff3811181e8), requires_capability(0x7ff383b092e8)]]
bool
Connect(
    xref:CService.adoc[CService] const& to,
    xref:i2p/Connection.adoc[Connection]& conn,
    bool& proxy_error);
----

== Return Value

true on success

== Parameters

[cols="1,4"]
|===
| Name| Description
| *to* [in]
| Peer to connect to.
| *conn* [out]
| Established connection. Only set if `true` is returned.
| *proxy_error* [out]
| If an error occurs due to proxy or general network failure, then this is set to `true`. If an error occurs due to unreachable peer (likely peer is down), then it is set to `false`. Only set if `false` is returned.
|===


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