summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Henry <[email protected]>2020-05-01 21:42:26 -0700
committerJoseph Henry <[email protected]>2020-05-01 21:42:26 -0700
commitdb0f801f07b316d58f3f0e73d18b95262732fdd8 (patch)
tree2be3771fbab48c7f936e6d5997d6bb510d1db2ad /README.md
parent3852e1f85f90c39eb17c4f8695c26f625d284633 (diff)
Update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index da67e90..c915f20 100644
--- a/README.md
+++ b/README.md
@@ -132,7 +132,7 @@ ZTS_EVENT_NETWORK_DOWN
# Connecting and communicating with peers
-Creating a standard socket connection generally works the same as it would using an ordinary socket interface, however with ZeroTier there is a subtle difference in how connections are established which may cause confusion. Since ZeroTier employs transport-triggered link provisioning a direct connection between peers will not exist until contact has been attempted by at least one peer. During this time before a direct link is available traffic will be handled via our free relay service. The provisioning of this direct link usually only takes a couple of seconds but it is important to understand that if you attempt something like s `zts_connect(...)` call during this time it may fail due to packet loss. Therefore it is advised to repeatedly call `zts_connect(...)` until it succeeds and to wait to send additional traffic until `ZTS_EVENT_PEER_P2P` has been received for the peer you are attempting to communicate with. All of the above is optional, but it will improve your experience.
+Creating a standard socket connection generally works the same as it would using an ordinary socket interface, however with ZeroTier there is a subtle difference in how connections are established which may cause confusion. Since ZeroTier employs transport-triggered link provisioning a direct connection between peers will not exist until contact has been attempted by at least one peer. During this time before a direct link is available traffic will be handled via our free relay service. The provisioning of this direct link usually only takes a couple of seconds but it is important to understand that if you attempt something like s `zts_connect(...)` call during this time it may fail due to packet loss. Therefore it is advised to repeatedly call `zts_connect(...)` until it succeeds and to wait to send additional traffic until `ZTS_EVENT_PEER_DIRECT` has been received for the peer you are attempting to communicate with. All of the above is optional, but it will improve your experience.
`tl;dr: Try a few times and wait a few seconds`