Skip to content

Commit

Permalink
Add a comment to NewPacketConn.
Browse files Browse the repository at this point in the history
  • Loading branch information
sbruens committed Nov 14, 2024
1 parent 81a8db4 commit ec75f60
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions transport/shadowsocks/packet_listener.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ type packetConn struct {

var _ net.PacketConn = (*packetConn)(nil)

// NewPacketConn wraps a [net.Conn] and returns a [net.PacketConn] that encrypts/decrypts
// packets before writing/reading them to/from the underlying connection using the provided
// encryption key.
//
// Closing the returned [net.PacketConn] will also close the underlying [net.Conn].
func NewPacketConn(conn net.Conn, key *EncryptionKey) net.PacketConn {
return &packetConn{Conn: conn, key: key}
}
Expand Down

0 comments on commit ec75f60

Please sign in to comment.