Skip to content

Commit

Permalink
add link in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ainghazal committed Jan 29, 2024
1 parent c941f02 commit 1bc2361
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion internal/reliabletransport/doc.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
// Package reliabletransport implements the reliable transport.
// Package reliabletransport implements the reliable transport module for OpenVPN.
// See [the official documentation](https://community.openvpn.net/openvpn/wiki/SecurityOverview) for a detail explanation
// of why this is needed, and how it relates to the requirements of the control channel.
// It is worth to mention that, even though the original need is to have a reliable control channel
// on top of UDP, this is also used when tunneling over TCP.
//
// A note about terminology: in this package, "receiver" is the moveUpWorker in the [reliabletransport.Service] (since it receives incoming packets), and
// "sender" is the moveDownWorker in the same service. The corresponding data structures lack mutexes because they are intended to be confined to a single
// goroutine (one for each worker), and they SHOULD ONLY communicate via message passing.
Expand Down

0 comments on commit 1bc2361

Please sign in to comment.